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:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeDialogflowService

Returns a new instance of DialogflowService.



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

def initialize
  super('https://dialogflow.googleapis.com/', '',
        client_name: 'google-apis-dialogflow_v3',
        client_version: Google::Apis::DialogflowV3::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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

Returns:

  • (String)

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



39
40
41
# File 'lib/google/apis/dialogflow_v3/service.rb', line 39

def key
  @key
end

#quota_userString

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

Returns:

  • (String)

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



44
45
46
# File 'lib/google/apis/dialogflow_v3/service.rb', line 44

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



2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2818

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.

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



2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2851

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



2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2886

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



3440
3441
3442
3443
3444
3445
3446
3447
3448
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3440

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



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

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

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

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



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

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.

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



391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/google/apis/dialogflow_v3/service.rb', line 391

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.

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



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

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



803
804
805
806
807
808
809
810
811
812
813
# File 'lib/google/apis/dialogflow_v3/service.rb', line 803

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



1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1174

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.

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.transition_routes.trigger_fulfillment. messages 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



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1360

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.

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.form.parameters.fill_behavior.initial_prompt_fulfillment. messages * Page.form.parameters.fill_behavior.reprompt_event_handlers. messages * Page.transition_routes.trigger_fulfillment.messages * Page. transition_route_groups.transition_routes.trigger_fulfillment.messages 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



1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1678

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.

Parameters:

  • parent (String)

    Required. The flow to create an TransitionRouteGroup for. Format: projects// locations//agents//flows/.

  • google_cloud_dialogflow_cx_v3_transition_route_group_object (Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TransitionRouteGroup) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    The language to list transition route groups for. The field messages in TransitionRoute is language dependent. 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



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

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.

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



2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2099

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

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



2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2311

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



2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2639

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



2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2919

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_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



3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3254

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



3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3549

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



107
108
109
110
111
112
113
114
115
# File 'lib/google/apis/dialogflow_v3/service.rb', line 107

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.

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



432
433
434
435
436
437
438
439
440
441
# File 'lib/google/apis/dialogflow_v3/service.rb', line 432

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



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

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



836
837
838
839
840
841
842
843
844
# File 'lib/google/apis/dialogflow_v3/service.rb', line 836

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



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

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



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1401

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.

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



1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1719

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.

Parameters:

  • name (String)

    Required. The name of the TransitionRouteGroup to delete. Format: projects// locations//agents//flows//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



1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1938

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



2132
2133
2134
2135
2136
2137
2138
2139
2140
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2132

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_intent(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV3::GoogleProtobufEmpty

Deletes the specified intent.

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



2345
2346
2347
2348
2349
2350
2351
2352
2353
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2345

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



2674
2675
2676
2677
2678
2679
2680
2681
2682
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2674

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_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



3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3294

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



3582
3583
3584
3585
3586
3587
3588
3589
3590
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3582

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

#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



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

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



2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2521

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.

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



139
140
141
142
143
144
145
146
147
148
149
# File 'lib/google/apis/dialogflow_v3/service.rb', line 139

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

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



2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2954

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



1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1098

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



2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2563

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_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



171
172
173
174
175
176
177
178
179
# File 'lib/google/apis/dialogflow_v3/service.rb', line 171

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_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



471
472
473
474
475
476
477
478
479
480
# File 'lib/google/apis/dialogflow_v3/service.rb', line 471

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



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

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_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



867
868
869
870
871
872
873
874
875
# File 'lib/google/apis/dialogflow_v3/service.rb', line 867

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



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

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. transition_routes.trigger_fulfillment.messages 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



1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1440

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.form.parameters. fill_behavior.initial_prompt_fulfillment.messages * Page.form.parameters. fill_behavior.reprompt_event_handlers.messages * Page.transition_routes. trigger_fulfillment.messages * Page.transition_route_groups. transition_routes.trigger_fulfillment.messages 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



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

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

  • language_code (String) (defaults to: nil)

    The language to list transition route groups for. The field messages in TransitionRoute is language dependent. 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



1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1976

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



1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1475

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



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

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_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



2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2382

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



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

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



2987
2988
2989
2990
2991
2992
2993
2994
2995
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2987

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



3169
3170
3171
3172
3173
3174
3175
3176
3177
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3169

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_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



205
206
207
208
209
210
211
212
213
214
# File 'lib/google/apis/dialogflow_v3/service.rb', line 205

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



3326
3327
3328
3329
3330
3331
3332
3333
3334
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3326

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



3471
3472
3473
3474
3475
3476
3477
3478
3479
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3471

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



3614
3615
3616
3617
3618
3619
3620
3621
3622
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3614

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



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

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_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 overwite any existing ones. The provided ID in the imported test case is neglected.

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



3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3021

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_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



515
516
517
518
519
520
521
522
523
524
525
526
# File 'lib/google/apis/dialogflow_v3/service.rb', line 515

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_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



903
904
905
906
907
908
909
910
911
912
913
# File 'lib/google/apis/dialogflow_v3/service.rb', line 903

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



1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1280

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



694
695
696
697
698
699
700
701
702
703
704
# File 'lib/google/apis/dialogflow_v3/service.rb', line 694

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.form.parameters.fill_behavior. initial_prompt_fulfillment.messages * Page.form.parameters.fill_behavior. reprompt_event_handlers.messages * Page.transition_routes. trigger_fulfillment.messages * Page.transition_route_groups. transition_routes.trigger_fulfillment.messages 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



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1808

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

  • language_code (String) (defaults to: nil)

    The language to list transition route groups for. The field messages in TransitionRoute is language dependent. 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



2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2019

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



2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2199

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.transition_routes. trigger_fulfillment.messages 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



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

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_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



2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2427

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



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2745

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 a list of results for a given 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



3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3219

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



3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3062

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_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



3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3362

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



241
242
243
244
245
246
247
248
249
250
251
# File 'lib/google/apis/dialogflow_v3/service.rb', line 241

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. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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



3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3514

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



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

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_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. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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



3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3801

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 a specified version to draft version.

Parameters:

  • name (String)

    Required. The Version to be loaded to draft version. 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



2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2233

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



732
733
734
735
736
737
738
739
740
741
742
# File 'lib/google/apis/dialogflow_v3/service.rb', line 732

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



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1138

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



2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2603

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.

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



279
280
281
282
283
284
285
286
287
288
289
290
# File 'lib/google/apis/dialogflow_v3/service.rb', line 279

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.

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



558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'lib/google/apis/dialogflow_v3/service.rb', line 558

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.

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



768
769
770
771
772
773
774
775
776
777
778
779
# File 'lib/google/apis/dialogflow_v3/service.rb', line 768

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



939
940
941
942
943
944
945
946
947
948
949
950
# File 'lib/google/apis/dialogflow_v3/service.rb', line 939

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



1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1318

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.

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.transition_routes.trigger_fulfillment. messages 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)

    Required. The mask to control which fields get updated. If update_mask is not specified, an error will be returned.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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.

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.form.parameters.fill_behavior.initial_prompt_fulfillment. messages * Page.form.parameters.fill_behavior.reprompt_event_handlers. messages * Page.transition_routes.trigger_fulfillment.messages * Page. transition_route_groups.transition_routes.trigger_fulfillment.messages 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



1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1856

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.

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 to list transition route groups for. The field messages in TransitionRoute is language dependent. 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



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

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



2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2270

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

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



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

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



2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
# File 'lib/google/apis/dialogflow_v3/service.rb', line 2783

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



3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3101

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_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



3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3400

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)

    Required. Resource name of the settings. 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



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

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.

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



316
317
318
319
320
321
322
323
324
325
326
# File 'lib/google/apis/dialogflow_v3/service.rb', line 316

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

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



3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
# File 'lib/google/apis/dialogflow_v3/service.rb', line 3136

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

#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



975
976
977
978
979
980
981
982
983
984
985
# File 'lib/google/apis/dialogflow_v3/service.rb', line 975

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



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1010

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

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

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



1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1600

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

#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



351
352
353
354
355
356
357
358
359
360
361
# File 'lib/google/apis/dialogflow_v3/service.rb', line 351

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



1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
# File 'lib/google/apis/dialogflow_v3/service.rb', line 1635

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