Class: Google::Apis::DialogflowV2::DialogflowService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/dialogflow_v2/service.rb

Overview

Dialogflow API

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

Examples:

require 'google/apis/dialogflow_v2'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeDialogflowService

Returns a new instance of DialogflowService.


46
47
48
49
# File 'generated/google/apis/dialogflow_v2/service.rb', line 46

def initialize
  super('https://dialogflow.googleapis.com/', '')
  @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 'generated/google/apis/dialogflow_v2/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 'generated/google/apis/dialogflow_v2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#agent_project(parent, google_cloud_dialogflow_v2_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent

Creates/updates the specified agent.

Parameters:

  • parent (String)

    Required. The project of this agent. Format: projects/<Project ID>.

  • google_cloud_dialogflow_v2_agent_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. 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:


75
76
77
78
79
80
81
82
83
84
85
86
# File 'generated/google/apis/dialogflow_v2/service.rb', line 75

def agent_project(parent, google_cloud_dialogflow_v2_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/agent', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent::Representation
  command.request_object = google_cloud_dialogflow_v2_agent_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent
  command.params['parent'] = parent unless parent.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

#batch_project_agent_entity_type_delete(parent, google_cloud_dialogflow_v2_batch_delete_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Deletes entity types in the specified agent. Operation

Parameters:

  • parent (String)

    Required. The name of the agent to delete all entities types for. Format: projects/<Project ID>/agent.

  • google_cloud_dialogflow_v2_batch_delete_entity_types_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest) (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:


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

def batch_project_agent_entity_type_delete(parent, google_cloud_dialogflow_v2_batch_delete_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/entityTypes:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_batch_delete_entity_types_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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

#batch_project_agent_entity_type_entity_create(parent, google_cloud_dialogflow_v2_batch_create_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Creates multiple new entities in the specified entity type. Operation

Parameters:

  • parent (String)

    Required. The name of the entity type to create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

  • google_cloud_dialogflow_v2_batch_create_entities_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchCreateEntitiesRequest) (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:


745
746
747
748
749
750
751
752
753
754
755
# File 'generated/google/apis/dialogflow_v2/service.rb', line 745

def batch_project_agent_entity_type_entity_create(parent, google_cloud_dialogflow_v2_batch_create_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/entities:batchCreate', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchCreateEntitiesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_batch_create_entities_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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

#batch_project_agent_entity_type_entity_delete(parent, google_cloud_dialogflow_v2_batch_delete_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Deletes entities in the specified entity type. Operation

Parameters:

  • parent (String)

    Required. The name of the entity type to delete entries for. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

  • google_cloud_dialogflow_v2_batch_delete_entities_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteEntitiesRequest) (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:


780
781
782
783
784
785
786
787
788
789
790
# File 'generated/google/apis/dialogflow_v2/service.rb', line 780

def batch_project_agent_entity_type_entity_delete(parent, google_cloud_dialogflow_v2_batch_delete_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/entities:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteEntitiesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_batch_delete_entities_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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

#batch_project_agent_entity_type_entity_update(parent, google_cloud_dialogflow_v2_batch_update_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation

Parameters:

  • parent (String)

    Required. The name of the entity type to update or create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

  • google_cloud_dialogflow_v2_batch_update_entities_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateEntitiesRequest) (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:


817
818
819
820
821
822
823
824
825
826
827
# File 'generated/google/apis/dialogflow_v2/service.rb', line 817

def batch_project_agent_entity_type_entity_update(parent, google_cloud_dialogflow_v2_batch_update_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/entities:batchUpdate', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateEntitiesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_batch_update_entities_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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

#batch_project_agent_entity_type_update(parent, google_cloud_dialogflow_v2_batch_update_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Updates/Creates multiple entity types in the specified agent. Operation

Parameters:

  • parent (String)

    Required. The name of the agent to update or create entity types in. Format: projects/<Project ID>/agent.

  • google_cloud_dialogflow_v2_batch_update_entity_types_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest) (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:


505
506
507
508
509
510
511
512
513
514
515
# File 'generated/google/apis/dialogflow_v2/service.rb', line 505

def batch_project_agent_entity_type_update(parent, google_cloud_dialogflow_v2_batch_update_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/entityTypes:batchUpdate', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_batch_update_entity_types_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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

#batch_project_agent_intent_delete(parent, google_cloud_dialogflow_v2_batch_delete_intents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Deletes intents in the specified agent. Operation

Parameters:

  • parent (String)

    Required. The name of the agent to delete all entities types for. Format: projects/<Project ID>/agent.

  • google_cloud_dialogflow_v2_batch_delete_intents_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteIntentsRequest) (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:


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1072

def batch_project_agent_intent_delete(parent, google_cloud_dialogflow_v2_batch_delete_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/intents:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteIntentsRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_batch_delete_intents_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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

#batch_project_agent_intent_update(parent, google_cloud_dialogflow_v2_batch_update_intents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Updates/Creates multiple intents in the specified agent. Operation

Parameters:

  • parent (String)

    Required. The name of the agent to update or create intents in. Format: projects/<Project ID>/agent.

  • google_cloud_dialogflow_v2_batch_update_intents_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateIntentsRequest) (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:


1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1107

def batch_project_agent_intent_update(parent, google_cloud_dialogflow_v2_batch_update_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/intents:batchUpdate', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateIntentsRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_batch_update_intents_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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

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


1953
1954
1955
1956
1957
1958
1959
1960
1961
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1953

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


2071
2072
2073
2074
2075
2076
2077
2078
2079
# File 'generated/google/apis/dialogflow_v2/service.rb', line 2071

def cancel_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:cancel', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2::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_agent_entity_type(parent, google_cloud_dialogflow_v2_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType

Creates an entity type in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to create a entity type for. Format: projects/<Project ID>/agent.

  • google_cloud_dialogflow_v2_entity_type_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    Optional. The language of entity synonyms defined in entity_type. 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:


546
547
548
549
550
551
552
553
554
555
556
557
# File 'generated/google/apis/dialogflow_v2/service.rb', line 546

def create_project_agent_entity_type(parent, google_cloud_dialogflow_v2_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType::Representation
  command.request_object = google_cloud_dialogflow_v2_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType
  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_agent_environment(parent, google_cloud_dialogflow_v2_environment_object = nil, environment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment

Creates an agent environment.

Parameters:

  • parent (String)

    Required. The agent to create a environment for. Format: projects/<Project ID>/agent.

  • google_cloud_dialogflow_v2_environment_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment) (defaults to: nil)
  • environment_id (String) (defaults to: nil)

    Required. The unique id of the new 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:


853
854
855
856
857
858
859
860
861
862
863
864
# File 'generated/google/apis/dialogflow_v2/service.rb', line 853

def create_project_agent_environment(parent, google_cloud_dialogflow_v2_environment_object = nil, environment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/environments', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment::Representation
  command.request_object = google_cloud_dialogflow_v2_environment_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment
  command.params['parent'] = parent unless parent.nil?
  command.query['environmentId'] = environment_id unless environment_id.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_agent_intent(parent, google_cloud_dialogflow_v2_intent_object = nil, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent

Creates an intent in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to create a intent for. Format: projects/<Project ID>/agent.

  • google_cloud_dialogflow_v2_intent_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent) (defaults to: nil)
  • intent_view (String) (defaults to: nil)

    Optional. The resource view to apply to the returned intent.

  • language_code (String) (defaults to: nil)

    Optional. The language of training phrases, parameters and rich messages defined in intent. 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:


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1150

def create_project_agent_intent(parent, google_cloud_dialogflow_v2_intent_object = nil, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/intents', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent::Representation
  command.request_object = google_cloud_dialogflow_v2_intent_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_agent_session_context(parent, google_cloud_dialogflow_v2_context_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context

Creates a context. If the specified context already exists, overrides the context.

Parameters:

  • parent (String)

    Required. The session to create a context for. Format: projects/<Project ID>/agent/sessions/<Session ID>.

  • google_cloud_dialogflow_v2_context_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context) (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:


1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1431

def create_project_agent_session_context(parent, google_cloud_dialogflow_v2_context_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/contexts', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context::Representation
  command.request_object = google_cloud_dialogflow_v2_context_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context
  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_agent_session_entity_type(parent, google_cloud_dialogflow_v2_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType

Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters:

  • parent (String)

    Required. The session to create a session entity type for. Format: projects/<Project ID>/agent/sessions/<Session ID>.

  • google_cloud_dialogflow_v2_session_entity_type_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType) (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:


1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1614

def create_project_agent_session_entity_type(parent, google_cloud_dialogflow_v2_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_v2_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType
  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_agent_version(parent, google_cloud_dialogflow_v2_version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version

Creates an agent version.

Parameters:

  • parent (String)

    Required. The agent to create a version for. Format: projects/<Project ID>/agent.

  • google_cloud_dialogflow_v2_version_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version) (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:


1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1802

def create_project_agent_version(parent, google_cloud_dialogflow_v2_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/versions', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version::Representation
  command.request_object = google_cloud_dialogflow_v2_version_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version
  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_agent(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleProtobufEmpty

Deletes the specified agent.

Parameters:

  • parent (String)

    Required. The project that the agent to delete is associated with. Format: projects/<Project ID>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


109
110
111
112
113
114
115
116
117
# File 'generated/google/apis/dialogflow_v2/service.rb', line 109

def delete_project_agent(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+parent}/agent', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2::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

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

Deletes the specified entity type.

Parameters:

  • name (String)

    Required. The name of the entity type to delete. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


580
581
582
583
584
585
586
587
588
# File 'generated/google/apis/dialogflow_v2/service.rb', line 580

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

Deletes the specified agent environment.

Parameters:

  • name (String)

    Required. The name of the environment to delete. Format: projects/<Project ID>/agent/environments/<Environment ID>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


887
888
889
890
891
892
893
894
895
# File 'generated/google/apis/dialogflow_v2/service.rb', line 887

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

Deletes the specified intent and its direct or indirect followup intents.

Parameters:

  • name (String)

    Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: projects/<Project ID>/agent/intents/<Intent ID>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1186
1187
1188
1189
1190
1191
1192
1193
1194
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1186

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

Deletes the specified context.

Parameters:

  • name (String)

    Required. The name of the context to delete. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1464
1465
1466
1467
1468
1469
1470
1471
1472
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1464

def delete_project_agent_session_context(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2::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_agent_session_contexts(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleProtobufEmpty

Deletes all active contexts in the specified session.

Parameters:

  • parent (String)

    Required. The name of the session to delete all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1358
1359
1360
1361
1362
1363
1364
1365
1366
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1358

def delete_project_agent_session_contexts(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+parent}/contexts', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2::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

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

Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters:

  • name (String)

    Required. The name of the entity type to delete. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1651
1652
1653
1654
1655
1656
1657
1658
1659
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1651

def delete_project_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2::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_agent_session_intent(session, google_cloud_dialogflow_v2_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentResponse

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.

Parameters:

  • session (String)

    Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID>. It's up to the API caller to choose an appropriate session ID. It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 bytes.

  • google_cloud_dialogflow_v2_detect_intent_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentRequest) (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:


1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1396

def detect_project_agent_session_intent(session, google_cloud_dialogflow_v2_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+session}:detectIntent', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentResponse
  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_agent(parent, google_cloud_dialogflow_v2_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Exports the specified agent to a ZIP file. Operation

Parameters:

  • parent (String)

    Required. The project that the agent to export is associated with. Format: projects/<Project ID>.

  • google_cloud_dialogflow_v2_export_agent_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportAgentRequest) (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:


173
174
175
176
177
178
179
180
181
182
183
# File 'generated/google/apis/dialogflow_v2/service.rb', line 173

def export_project_agent(parent, google_cloud_dialogflow_v2_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/agent:export', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_export_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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

#get_project_agent(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent

Retrieves the specified agent.

Parameters:

  • parent (String)

    Required. The project that the agent to fetch is associated with. Format: projects/<Project ID>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


140
141
142
143
144
145
146
147
148
# File 'generated/google/apis/dialogflow_v2/service.rb', line 140

def get_project_agent(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/agent', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent
  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

#get_project_agent_entity_type(name, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType

Retrieves the specified entity type.

Parameters:

  • name (String)

    Required. The name of the entity type. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

  • language_code (String) (defaults to: nil)

    Optional. The language to retrieve entity synonyms for. 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:


618
619
620
621
622
623
624
625
626
627
# File 'generated/google/apis/dialogflow_v2/service.rb', line 618

def get_project_agent_entity_type(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType
  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_agent_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment

Retrieves the specified agent environment.

Parameters:

  • name (String)

    Required. The name of the environment. Format: projects/<Project ID>/agent/environments/<Environment ID>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


918
919
920
921
922
923
924
925
926
# File 'generated/google/apis/dialogflow_v2/service.rb', line 918

def get_project_agent_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment
  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_agent_environment_history(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EnvironmentHistory

Gets the history of the specified environment.

Parameters:

  • parent (String)

    Required. The name of the environment to retrieve history for. Format: projects/<Project ID>/agent/environments/<Environment ID>.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


955
956
957
958
959
960
961
962
963
964
965
# File 'generated/google/apis/dialogflow_v2/service.rb', line 955

def get_project_agent_environment_history(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/history', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EnvironmentHistory::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EnvironmentHistory
  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

#get_project_agent_fulfillment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Fulfillment

Retrieves the fulfillment.

Parameters:

  • name (String)

    Required. The name of the fulfillment. Format: projects/<Project ID>/agent/fulfillment.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def get_project_agent_fulfillment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Fulfillment::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Fulfillment
  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_agent_intent(name, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent

Retrieves the specified intent.

Parameters:

  • name (String)

    Required. The name of the intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

  • intent_view (String) (defaults to: nil)

    Optional. The resource view to apply to the returned intent.

  • language_code (String) (defaults to: nil)

    Optional. The language to retrieve training phrases, parameters and rich messages for. 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:


1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1226

def get_project_agent_intent(name, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent
  command.params['name'] = name unless name.nil?
  command.query['intentView'] = intent_view unless intent_view.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_agent_session_context(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context

Retrieves the specified context.

Parameters:

  • name (String)

    Required. The name of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1495
1496
1497
1498
1499
1500
1501
1502
1503
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1495

def get_project_agent_session_context(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context
  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_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType

Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters:

  • name (String)

    Required. The name of the session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1686
1687
1688
1689
1690
1691
1692
1693
1694
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1686

def get_project_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType
  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_agent_validation_result(parent, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ValidationResult

Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.

Parameters:

  • parent (String)

    Required. The project that the agent is associated with. Format: projects/<Project ID>.

  • language_code (String) (defaults to: nil)

    Optional. The language for which you want a validation result. 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:


244
245
246
247
248
249
250
251
252
253
# File 'generated/google/apis/dialogflow_v2/service.rb', line 244

def get_project_agent_validation_result(parent, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/agent/validationResult', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ValidationResult::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ValidationResult
  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

#get_project_agent_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version

Retrieves the specified agent version.

Parameters:

  • name (String)

    Required. The name of the version. Format: projects/<Project ID>/agent/versions/<Version ID>.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1835
1836
1837
1838
1839
1840
1841
1842
1843
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1835

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


1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1985

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


2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'generated/google/apis/dialogflow_v2/service.rb', line 2103

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

Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. Operation

Parameters:

  • parent (String)

    Required. The project that the agent to import is associated with. Format: projects/<Project ID>.

  • google_cloud_dialogflow_v2_import_agent_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportAgentRequest) (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:


281
282
283
284
285
286
287
288
289
290
291
# File 'generated/google/apis/dialogflow_v2/service.rb', line 281

def import_project_agent(parent, google_cloud_dialogflow_v2_import_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/agent:import', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_import_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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_agent_entity_types(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEntityTypesResponse

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

Parameters:

  • parent (String)

    Required. The agent to list all entity types from. Format: projects/<Project ID>/agent.

  • language_code (String) (defaults to: nil)

    Optional. The language to list entity synonyms for. 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)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


662
663
664
665
666
667
668
669
670
671
672
673
# File 'generated/google/apis/dialogflow_v2/service.rb', line 662

def list_project_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, 'v2/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEntityTypesResponse
  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_agent_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEnvironmentsResponse

Returns the list of all environments of the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list all environments from. Format: projects/<Project ID>/agent.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


994
995
996
997
998
999
1000
1001
1002
1003
1004
# File 'generated/google/apis/dialogflow_v2/service.rb', line 994

def list_project_agent_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/environments', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEnvironmentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListEnvironmentsResponse
  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_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::DialogflowV2::GoogleCloudDialogflowV2ListIntentsResponse

Returns the list of all intents in the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list all intents from. Format: projects/<Project ID>/agent.

  • intent_view (String) (defaults to: nil)

    Optional. The resource view to apply to the returned intent.

  • language_code (String) (defaults to: nil)

    Optional. The language to list training phrases, parameters and rich messages for. 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)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1273

def list_project_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, 'v2/{+parent}/intents', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListIntentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListIntentsResponse
  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_agent_session_contexts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListContextsResponse

Returns the list of all contexts in the specified session.

Parameters:

  • parent (String)

    Required. The session to list all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID>.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1531

def list_project_agent_session_contexts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/contexts', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListContextsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListContextsResponse
  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_agent_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListSessionEntityTypesResponse

Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters:

  • parent (String)

    Required. The session to list all session entity types from. Format: projects/<Project ID>/agent/sessions/<Session ID>.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1725

def list_project_agent_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListSessionEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListSessionEntityTypesResponse
  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_agent_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListVersionsResponse

Returns the list of all versions of the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list all versions from. Format: projects/<Project ID>/agent.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1872

def list_project_agent_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/versions', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListVersionsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListVersionsResponse
  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::DialogflowV2::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:


2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
# File 'generated/google/apis/dialogflow_v2/service.rb', line 2029

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, 'v2/{+name}/operations', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::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_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::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:


2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
# File 'generated/google/apis/dialogflow_v2/service.rb', line 2147

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

#patch_project_agent_entity_type(name, google_cloud_dialogflow_v2_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType

Updates the specified entity type.

Parameters:

  • name (String)

    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

  • google_cloud_dialogflow_v2_entity_type_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType) (defaults to: nil)
  • language_code (String) (defaults to: nil)

    Optional. The language of entity synonyms defined in entity_type. 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)

    Optional. 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:


708
709
710
711
712
713
714
715
716
717
718
719
720
# File 'generated/google/apis/dialogflow_v2/service.rb', line 708

def patch_project_agent_entity_type(name, google_cloud_dialogflow_v2_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType::Representation
  command.request_object = google_cloud_dialogflow_v2_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType
  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_agent_environment(name, google_cloud_dialogflow_v2_environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment

Updates the specified agent environment. This method allows you to deploy new agent versions into the environment. When a environment is pointed to a new agent version by setting environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state.

Parameters:

  • name (String)

    Output only. The unique identifier of this agent environment. Format: projects/<Project ID>/agent/environments/<Environment ID>.

  • google_cloud_dialogflow_v2_environment_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. 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:


1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1036

def patch_project_agent_environment(name, google_cloud_dialogflow_v2_environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment::Representation
  command.request_object = google_cloud_dialogflow_v2_environment_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment
  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_agent_intent(name, google_cloud_dialogflow_v2_intent_object = nil, intent_view: nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent

Updates the specified intent.

Parameters:

  • name (String)

    The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: projects/<Project ID>/agent/intents/<Intent ID>.

  • google_cloud_dialogflow_v2_intent_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent) (defaults to: nil)
  • intent_view (String) (defaults to: nil)

    Optional. The resource view to apply to the returned intent.

  • language_code (String) (defaults to: nil)

    Optional. The language of training phrases, parameters and rich messages defined in intent. 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)

    Optional. 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:


1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1322

def patch_project_agent_intent(name, google_cloud_dialogflow_v2_intent_object = nil, intent_view: nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent::Representation
  command.request_object = google_cloud_dialogflow_v2_intent_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent
  command.params['name'] = name unless name.nil?
  command.query['intentView'] = intent_view unless intent_view.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_agent_session_context(name, google_cloud_dialogflow_v2_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context

Updates the specified context.

Parameters:

  • name (String)

    Required. The unique identifier of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>. The Context ID is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names:

    • __system_counters__
    • *_id_dialog_context
    • *_dialog_params_size
  • google_cloud_dialogflow_v2_context_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. 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:


1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1574

def patch_project_agent_session_context(name, google_cloud_dialogflow_v2_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context::Representation
  command.request_object = google_cloud_dialogflow_v2_context_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context
  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_agent_session_entity_type(name, google_cloud_dialogflow_v2_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType

Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters:

  • name (String)

    Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. <Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

  • google_cloud_dialogflow_v2_session_entity_type_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. 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:


1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1767

def patch_project_agent_session_entity_type(name, google_cloud_dialogflow_v2_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_v2_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType
  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_agent_version(name, google_cloud_dialogflow_v2_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version

Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

Parameters:

  • name (String)

    Output only. The unique identifier of this agent version. Format: projects/<Project ID>/agent/versions/<Version ID>.

  • google_cloud_dialogflow_v2_version_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. 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:


1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1911

def patch_project_agent_version(name, google_cloud_dialogflow_v2_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version::Representation
  command.request_object = google_cloud_dialogflow_v2_version_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Version
  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_agent(parent, google_cloud_dialogflow_v2_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. Operation

Parameters:

  • parent (String)

    Required. The project that the agent to restore is associated with. Format: projects/<Project ID>.

  • google_cloud_dialogflow_v2_restore_agent_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2RestoreAgentRequest) (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:


318
319
320
321
322
323
324
325
326
327
328
# File 'generated/google/apis/dialogflow_v2/service.rb', line 318

def restore_project_agent(parent, google_cloud_dialogflow_v2_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/agent:restore', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2RestoreAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_restore_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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

#search_project_agents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchAgentsResponse

Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Parameters:

  • parent (String)

    Required. The project to list agents from. Format: projects/<Project ID or '-'>.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    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:


362
363
364
365
366
367
368
369
370
371
372
# File 'generated/google/apis/dialogflow_v2/service.rb', line 362

def search_project_agents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/agent:search', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchAgentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchAgentsResponse
  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

#train_project_agent(parent, google_cloud_dialogflow_v2_train_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Trains the specified agent. Operation

Parameters:

  • parent (String)

    Required. The project that the agent to train is associated with. Format: projects/<Project ID>.

  • google_cloud_dialogflow_v2_train_agent_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TrainAgentRequest) (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:


397
398
399
400
401
402
403
404
405
406
407
# File 'generated/google/apis/dialogflow_v2/service.rb', line 397

def train_project_agent(parent, google_cloud_dialogflow_v2_train_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/agent:train', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TrainAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_train_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::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

#update_project_agent_fulfillment(name, google_cloud_dialogflow_v2_fulfillment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Fulfillment

Updates the fulfillment.

Parameters:

  • name (String)

    Required. The unique identifier of the fulfillment. Format: projects/<Project ID>/agent/fulfillment.

  • google_cloud_dialogflow_v2_fulfillment_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Fulfillment) (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:


434
435
436
437
438
439
440
441
442
443
444
445
# File 'generated/google/apis/dialogflow_v2/service.rb', line 434

def update_project_agent_fulfillment(name, google_cloud_dialogflow_v2_fulfillment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Fulfillment::Representation
  command.request_object = google_cloud_dialogflow_v2_fulfillment_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Fulfillment::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Fulfillment
  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