Class: Google::Apis::DialogflowV3::DialogflowService

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

Overview

Dialogflow API

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

Examples:

require 'google/apis/dialogflow_v3'

Dialogflow = Google::Apis::DialogflowV3 # 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

#initialize ⇒ DialogflowService

Returns a new instance of DialogflowService.



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

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

Instance Attribute Details

#key ⇒ String

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_v3/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

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_v3/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_v3_batch_delete_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleProtobufEmpty

Batch deletes test cases.

Parameters:

  • parent (String) —

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

  • google_cloud_dialogflow_cx_v3_batch_delete_test_cases_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest) (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



3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3904

def batch_project_location_agent_test_case_delete(parent, google_cloud_dialogflow_cx_v3_batch_delete_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/testCases:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_batch_delete_test_cases_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_batch_run_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_batch_run_test_cases_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchRunTestCasesRequest) (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



3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3940

def batch_project_location_agent_test_case_run(parent, google_cloud_dialogflow_cx_v3_batch_run_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/testCases:batchRun', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BatchRunTestCasesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_batch_run_test_cases_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowCxV3CalculateCoverageResponse

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



3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3975

def calculate_project_location_agent_test_case_coverage(agent, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+agent}/testCases:calculateCoverage', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CalculateCoverageResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CalculateCoverageResponse
  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::DialogflowV3::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



4763
4764
4765
4766
4767
4768
4769
4770
4771
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4763

def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:cancel', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



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

def cancel_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:cancel', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_compare_versions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse

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_v3_compare_versions_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsRequest) (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



2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2789

def compare_project_location_agent_flow_version_versions(base_version, google_cloud_dialogflow_cx_v3_compare_versions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+baseVersion}:compareVersions', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_compare_versions_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3CompareVersionsResponse
  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_v3_agent_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent

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

Parameters:

  • parent (String) —

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

  • google_cloud_dialogflow_cx_v3_agent_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent) (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_v3/service.rb', line 151

def create_project_location_agent(parent, google_cloud_dialogflow_cx_v3_agent_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/agents', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_agent_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent
  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_v3_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType

Creates an entity type 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 entity type for. Format: projects//locations// agents/.

  • google_cloud_dialogflow_cx_v3_entity_type_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType) (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



636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 636

def create_project_location_agent_entity_type(parent, google_cloud_dialogflow_cx_v3_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType
  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_v3_environment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_environment_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment) (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



916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 916

def create_project_location_agent_environment(parent, google_cloud_dialogflow_cx_v3_environment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/environments', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_environment_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_experiment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment

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_v3_experiment_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment) (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



1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1310

def create_project_location_agent_environment_experiment(parent, google_cloud_dialogflow_cx_v3_experiment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/experiments', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_experiment_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
  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_v3_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType

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_v3_session_entity_type_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType) (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



1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1726

def create_project_location_agent_environment_session_entity_type(parent, google_cloud_dialogflow_cx_v3_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
  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_v3_flow_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow

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_v3_flow_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow) (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



1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1915

def create_project_location_agent_flow(parent, google_cloud_dialogflow_cx_v3_flow_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/flows', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_flow_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow
  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_v3_page_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page

Creates a page 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 a page for. Format: projects//locations//agents// flows/.

  • google_cloud_dialogflow_cx_v3_page_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page) (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



2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2335

def create_project_location_agent_flow_page(parent, google_cloud_dialogflow_cx_v3_page_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/pages', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_page_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page
  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_v3_transition_route_group_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup

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_v3_transition_route_group_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup) (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



2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2576

def create_project_location_agent_flow_transition_route_group(parent, google_cloud_dialogflow_cx_v3_transition_route_group_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/transitionRouteGroups', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_transition_route_group_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup
  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_v3_version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_version_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version) (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



2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2826

def create_project_location_agent_flow_version(parent, google_cloud_dialogflow_cx_v3_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/versions', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_version_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_generator_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator

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_v3_generator_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator) (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



3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3041

def create_project_location_agent_generator(parent, google_cloud_dialogflow_cx_v3_generator_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/generators', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_generator_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator
  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_v3_intent_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent

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_v3_intent_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent) (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



3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3239

def create_project_location_agent_intent(parent, google_cloud_dialogflow_cx_v3_intent_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/intents', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_intent_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent
  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_session_entity_type(parent, google_cloud_dialogflow_cx_v3_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType

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_v3_session_entity_type_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType) (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



3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3725

def create_project_location_agent_session_entity_type(parent, google_cloud_dialogflow_cx_v3_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
  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_v3_test_case_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase

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_v3_test_case_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase) (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



4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4008

def create_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3_test_case_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/testCases', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_test_case_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase
  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_v3_transition_route_group_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup

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_v3_transition_route_group_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup) (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



4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4365

def create_project_location_agent_transition_route_group(parent, google_cloud_dialogflow_cx_v3_transition_route_group_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/transitionRouteGroups', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_transition_route_group_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup
  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_v3_webhook_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook

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_v3_webhook_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook) (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



4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4577

def create_project_location_agent_webhook(parent, google_cloud_dialogflow_cx_v3_webhook_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/webhooks', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_webhook_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook
  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_v3_security_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings

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_v3_security_settings_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings) (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



4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4866

def create_project_location_security_setting(parent, google_cloud_dialogflow_cx_v3_security_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/securitySettings', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_security_settings_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings
  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::DialogflowV3::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_v3/service.rb', line 184

def delete_project_location_agent(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



679
680
681
682
683
684
685
686
687
688
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 679

def delete_project_location_agent_entity_type(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



949
950
951
952
953
954
955
956
957
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 949

def delete_project_location_agent_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



1343
1344
1345
1346
1347
1348
1349
1350
1351
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1343

def delete_project_location_agent_environment_experiment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1761

def delete_project_location_agent_environment_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1956

def delete_project_location_agent_flow(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::GoogleProtobufEmpty

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

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



2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2378

def delete_project_location_agent_flow_page(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2619

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, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2859

def delete_project_location_agent_flow_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3081

def delete_project_location_agent_generator(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



3275
3276
3277
3278
3279
3280
3281
3282
3283
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3275

def delete_project_location_agent_intent(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



3760
3761
3762
3763
3764
3765
3766
3767
3768
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3760

def delete_project_location_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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_transition_route_group(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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



4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4408

def delete_project_location_agent_transition_route_group(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4617

def delete_project_location_agent_webhook(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



4899
4900
4901
4902
4903
4904
4905
4906
4907
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4899

def delete_project_location_security_setting(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_deploy_flow_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_deploy_flow_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DeployFlowRequest) (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



984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 984

def deploy_project_location_agent_environment_flow(environment, google_cloud_dialogflow_cx_v3_deploy_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+environment}:deployFlow', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DeployFlowRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_deploy_flow_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse

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_v3_detect_intent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest) (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



1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1563

def detect_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+session}:detectIntent', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse
  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_v3_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse

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_v3_detect_intent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest) (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



3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3528

def detect_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+session}:detectIntent', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse
  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_v3_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_export_agent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportAgentRequest) (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_v3/service.rb', line 221

def export_project_location_agent(name, google_cloud_dialogflow_cx_v3_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:export', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_export_agent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_export_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_export_entity_types_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportEntityTypesRequest) (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



712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 712

def export_project_location_agent_entity_type(parent, google_cloud_dialogflow_cx_v3_export_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/entityTypes:export', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportEntityTypesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_export_entity_types_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_export_flow_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_export_flow_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportFlowRequest) (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



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1995

def export_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3_export_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:export', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportFlowRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_export_flow_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_export_intents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_export_intents_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportIntentsRequest) (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



3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3310

def export_project_location_agent_intent(parent, google_cloud_dialogflow_cx_v3_export_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/intents:export', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportIntentsRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_export_intents_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_test_case(parent, google_cloud_dialogflow_cx_v3_export_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_export_test_cases_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportTestCasesRequest) (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



4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4047

def export_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3_export_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/testCases:export', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ExportTestCasesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_export_test_cases_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_fulfill_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse

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_v3_fulfill_intent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentRequest) (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



1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1605

def fulfill_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3_fulfill_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+session}:fulfillIntent', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_fulfill_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse
  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_v3_fulfill_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse

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_v3_fulfill_intent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentRequest) (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



3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3570

def fulfill_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3_fulfill_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+session}:fulfillIntent', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_fulfill_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillIntentResponse
  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::DialogflowV3::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_v3/service.rb', line 75

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudLocationLocation::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowCxV3Agent

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_v3/service.rb', line 253

def get_project_location_agent(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent
  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::DialogflowV3::GoogleCloudDialogflowCxV3Changelog

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_v3/service.rb', line 546

def get_project_location_agent_changelog(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Changelog
  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::DialogflowV3::GoogleCloudDialogflowCxV3EntityType

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



752
753
754
755
756
757
758
759
760
761
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 752

def get_project_location_agent_entity_type(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType
  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::DialogflowV3::GoogleCloudDialogflowCxV3Environment

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



1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1017

def get_project_location_agent_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment
  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::DialogflowV3::GoogleCloudDialogflowCxV3Deployment

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



1240
1241
1242
1243
1244
1245
1246
1247
1248
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1240

def get_project_location_agent_environment_deployment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Deployment
  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::DialogflowV3::GoogleCloudDialogflowCxV3Experiment

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



1374
1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1374

def get_project_location_agent_environment_experiment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
  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::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType

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



1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1794

def get_project_location_agent_environment_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
  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::DialogflowV3::GoogleCloudDialogflowCxV3Flow

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



2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2037

def get_project_location_agent_flow(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow
  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::DialogflowV3::GoogleCloudDialogflowCxV3Page

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



2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2424

def get_project_location_agent_flow_page(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page
  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::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup

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



2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2660

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, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup
  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::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult

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



2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2072

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, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult
  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::DialogflowV3::GoogleCloudDialogflowCxV3Version

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



2890
2891
2892
2893
2894
2895
2896
2897
2898
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2890

def get_project_location_agent_flow_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version
  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::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettings

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_v3/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, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettings::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettings
  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::DialogflowV3::GoogleCloudDialogflowCxV3Generator

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



3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3115

def get_project_location_agent_generator(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator
  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::DialogflowV3::GoogleCloudDialogflowCxV3Intent

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



3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3349

def get_project_location_agent_intent(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent
  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_session_entity_type(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType

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



3793
3794
3795
3796
3797
3798
3799
3800
3801
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3793

def get_project_location_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
  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::DialogflowV3::GoogleCloudDialogflowCxV3TestCase

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



4080
4081
4082
4083
4084
4085
4086
4087
4088
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4080

def get_project_location_agent_test_case(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase
  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::DialogflowV3::GoogleCloudDialogflowCxV3TestCaseResult

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



4269
4270
4271
4272
4273
4274
4275
4276
4277
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4269

def get_project_location_agent_test_case_result(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCaseResult::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCaseResult
  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::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup

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



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

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, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup
  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::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult

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_v3/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, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult
  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::DialogflowV3::GoogleCloudDialogflowCxV3Webhook

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



4649
4650
4651
4652
4653
4654
4655
4656
4657
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4649

def get_project_location_agent_webhook(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook
  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::DialogflowV3::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



4794
4795
4796
4797
4798
4799
4800
4801
4802
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4794

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings

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



4931
4932
4933
4934
4935
4936
4937
4938
4939
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4931

def get_project_location_security_setting(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings
  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::DialogflowV3::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



5077
5078
5079
5080
5081
5082
5083
5084
5085
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 5077

def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_import_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_import_entity_types_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportEntityTypesRequest) (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



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

def import_project_location_agent_entity_type(parent, google_cloud_dialogflow_cx_v3_import_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/entityTypes:import', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportEntityTypesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_import_entity_types_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_import_flow_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_import_flow_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportFlowRequest) (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



2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2112

def import_project_location_agent_flow(parent, google_cloud_dialogflow_cx_v3_import_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/flows:import', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportFlowRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_import_flow_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_import_intents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_import_intents_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportIntentsRequest) (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



3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3386

def import_project_location_agent_intent(parent, google_cloud_dialogflow_cx_v3_import_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/intents:import', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportIntentsRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_import_intents_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_import_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_import_test_cases_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportTestCasesRequest) (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



4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4118

def import_project_location_agent_test_case(parent, google_cloud_dialogflow_cx_v3_import_test_cases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+parent}/testCases:import', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ImportTestCasesRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_import_test_cases_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse

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_v3/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, 'v3/{+parent}/changelogs', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListChangelogsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListEntityTypesResponse

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



830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 830

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, 'v3/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEntityTypesResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse

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



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1207

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, 'v3/{+parent}/continuousTestResults', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse

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



1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1276

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, 'v3/{+parent}/deployments', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListDeploymentsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListExperimentsResponse

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



1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1410

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, 'v3/{+parent}/experiments', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListExperimentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListExperimentsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse

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



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

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, 'v3/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListEnvironmentsResponse

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



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1053

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, 'v3/{+parent}/environments', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEnvironmentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListEnvironmentsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListPagesResponse

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



2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2475

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, 'v3/{+parent}/pages', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListPagesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListPagesResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse

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



2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2705

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, 'v3/{+parent}/transitionRouteGroups', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListVersionsResponse

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



2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2926

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, 'v3/{+parent}/versions', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListVersionsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListVersionsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListFlowsResponse

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



2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2159

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, 'v3/{+parent}/flows', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListFlowsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListFlowsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListGeneratorsResponse

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



3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3154

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, 'v3/{+parent}/generators', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListGeneratorsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListGeneratorsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListIntentsResponse

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



3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3432

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, 'v3/{+parent}/intents', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListIntentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListIntentsResponse
  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_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse

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



3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3831

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, 'v3/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCaseResultsResponse

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



4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4320

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, 'v3/{+parent}/results', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCaseResultsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCaseResultsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCasesResponse

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



4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4159

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, 'v3/{+parent}/testCases', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCasesResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTestCasesResponse
  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_transition_route_groups(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse

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



4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4494

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, 'v3/{+parent}/transitionRouteGroups', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListWebhooksResponse

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



4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4685

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, 'v3/{+parent}/webhooks', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListWebhooksResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListWebhooksResponse
  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::DialogflowV3::GoogleCloudDialogflowCxV3ListAgentsResponse

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_v3/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, 'v3/{+parent}/agents', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListAgentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListAgentsResponse
  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::DialogflowV3::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



4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4831

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, 'v3/{+name}/operations', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowCxV3ListSecuritySettingsResponse

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



4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4967

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, 'v3/{+parent}/securitySettings', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSecuritySettingsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ListSecuritySettingsResponse
  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::DialogflowV3::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_v3/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, 'v3/{+name}/locations', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudLocationListLocationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::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



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

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, 'v3/{+name}/operations', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_load_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_load_version_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LoadVersionRequest) (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



2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2966

def load_project_location_agent_flow_version(name, google_cloud_dialogflow_cx_v3_load_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:load', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LoadVersionRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_load_version_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse

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



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

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, 'v3/{+name}:lookupEnvironmentHistory', options)
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse
  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_v3_match_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse

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_v3_match_intent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentRequest) (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



1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1645

def match_project_location_agent_environment_session_intent(session, google_cloud_dialogflow_cx_v3_match_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+session}:matchIntent', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_match_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse
  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_v3_match_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse

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_v3_match_intent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentRequest) (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



3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3610

def match_project_location_agent_session_intent(session, google_cloud_dialogflow_cx_v3_match_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+session}:matchIntent', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_match_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3MatchIntentResponse
  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_v3_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent

Updates the specified agent. Note: You should always train flows prior to sending them 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_v3_agent_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent) (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_v3/service.rb', line 396

def patch_project_location_agent(name, google_cloud_dialogflow_cx_v3_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_agent_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent
  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_v3_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType

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_v3_entity_type_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType) (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



875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 875

def patch_project_location_agent_entity_type(name, google_cloud_dialogflow_cx_v3_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3EntityType
  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_v3_environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_environment_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment) (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



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1131

def patch_project_location_agent_environment(name, google_cloud_dialogflow_cx_v3_environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Environment::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_environment_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_experiment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment

Updates the specified Experiment.

Parameters:

  • name (String) —

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

  • google_cloud_dialogflow_cx_v3_experiment_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment) (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



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1446

def patch_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3_experiment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_experiment_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
  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_v3_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType

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_v3_session_entity_type_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType) (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



1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1870

def patch_project_location_agent_environment_session_entity_type(name, google_cloud_dialogflow_cx_v3_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
  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_v3_flow_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow

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_v3_flow_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow) (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



2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2207

def patch_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3_flow_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_flow_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Flow
  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_v3_page_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page

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

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_v3_page_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page) (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



2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2530

def patch_project_location_agent_flow_page(name, google_cloud_dialogflow_cx_v3_page_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_page_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page
  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_v3_transition_route_group_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup

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/ .

  • google_cloud_dialogflow_cx_v3_transition_route_group_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup) (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



2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2752

def patch_project_location_agent_flow_transition_route_group(name, google_cloud_dialogflow_cx_v3_transition_route_group_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_transition_route_group_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup
  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_v3_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version

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_v3_version_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version) (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



3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3003

def patch_project_location_agent_flow_version(name, google_cloud_dialogflow_cx_v3_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_version_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Version
  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_v3_generator_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator

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_v3_generator_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator) (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



3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3195

def patch_project_location_agent_generator(name, google_cloud_dialogflow_cx_v3_generator_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_generator_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Generator
  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_v3_intent_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent

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_v3_intent_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent) (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



3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3480

def patch_project_location_agent_intent(name, google_cloud_dialogflow_cx_v3_intent_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_intent_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent
  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_session_entity_type(name, google_cloud_dialogflow_cx_v3_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType

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_v3_session_entity_type_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType) (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



3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3869

def patch_project_location_agent_session_entity_type(name, google_cloud_dialogflow_cx_v3_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionEntityType
  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_v3_test_case_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase

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_v3_test_case_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase) (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



4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4198

def patch_project_location_agent_test_case(name, google_cloud_dialogflow_cx_v3_test_case_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_test_case_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TestCase
  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_v3_transition_route_group_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup

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/ .

  • google_cloud_dialogflow_cx_v3_transition_route_group_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup) (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



4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4541

def patch_project_location_agent_transition_route_group(name, google_cloud_dialogflow_cx_v3_transition_route_group_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_transition_route_group_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup
  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_v3_webhook_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook

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_v3_webhook_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook) (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



4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4723

def patch_project_location_agent_webhook(name, google_cloud_dialogflow_cx_v3_webhook_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_webhook_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Webhook
  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_v3_security_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings

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_v3_security_settings_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings) (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



5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 5006

def patch_project_location_security_setting(name, google_cloud_dialogflow_cx_v3_security_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_security_settings_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SecuritySettings
  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_v3_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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 flows prior to sending them 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_v3_restore_agent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RestoreAgentRequest) (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_v3/service.rb', line 441

def restore_project_location_agent(name, google_cloud_dialogflow_cx_v3_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:restore', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RestoreAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_restore_agent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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

#run_project_location_agent_environment_continuous_test(environment, google_cloud_dialogflow_cx_v3_run_continuous_test_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_run_continuous_test_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RunContinuousTestRequest) (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



1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1169

def run_project_location_agent_environment_continuous_test(environment, google_cloud_dialogflow_cx_v3_run_continuous_test_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+environment}:runContinuousTest', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RunContinuousTestRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_run_continuous_test_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_run_test_case_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_run_test_case_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RunTestCaseRequest) (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



4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 4236

def run_project_location_agent_test_case(name, google_cloud_dialogflow_cx_v3_run_test_case_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:run', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3RunTestCaseRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_run_test_case_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse

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_v3_detect_intent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest) (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



1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1690

def server_project_location_agent_environment_session_streaming_detect_intent(session, google_cloud_dialogflow_cx_v3_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+session}:serverStreamingDetectIntent', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse
  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_v3_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse

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_v3_detect_intent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest) (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



3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3655

def server_project_location_agent_session_streaming_detect_intent(session, google_cloud_dialogflow_cx_v3_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+session}:serverStreamingDetectIntent', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3DetectIntentResponse
  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_v3_start_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment

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_v3_start_experiment_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3StartExperimentRequest) (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



1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1482

def start_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3_start_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:start', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3StartExperimentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_start_experiment_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
  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_v3_stop_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment

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_v3_stop_experiment_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3StopExperimentRequest) (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



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1517

def stop_project_location_agent_environment_experiment(name, google_cloud_dialogflow_cx_v3_stop_experiment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:stop', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3StopExperimentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_stop_experiment_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Experiment
  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_v3_submit_answer_feedback_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AnswerFeedback

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_v3_submit_answer_feedback_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest) (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



3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3689

def submit_project_location_agent_session_answer_feedback(session, google_cloud_dialogflow_cx_v3_submit_answer_feedback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+session}:submitAnswerFeedback', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_submit_answer_feedback_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AnswerFeedback::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AnswerFeedback
  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_v3_train_flow_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::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_v3_train_flow_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TrainFlowRequest) (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



2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2250

def train_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3_train_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:train', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TrainFlowRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_train_flow_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV3::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_v3_generative_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettings

Updates the generative settings for the agent.

Parameters:

  • name (String) —

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

  • google_cloud_dialogflow_cx_v3_generative_settings_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettings) (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_v3/service.rb', line 477

def update_project_location_agent_generative_settings(name, google_cloud_dialogflow_cx_v3_generative_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v3/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettings::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_generative_settings_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettings::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettings
  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_v3_validate_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult

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_v3_validate_agent_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ValidateAgentRequest) (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_v3/service.rb', line 513

def validate_project_location_agent(name, google_cloud_dialogflow_cx_v3_validate_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:validate', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ValidateAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_validate_agent_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentValidationResult
  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_v3_validate_flow_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult

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_v3_validate_flow_request_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ValidateFlowRequest) (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



2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
 
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2285

def validate_project_location_agent_flow(name, google_cloud_dialogflow_cx_v3_validate_flow_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3/{+name}:validate', options)
  command.request_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ValidateFlowRequest::Representation
  command.request_object = google_cloud_dialogflow_cx_v3_validate_flow_request_object
  command.response_representation = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult::Representation
  command.response_class = Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FlowValidationResult
  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