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

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

Overview

Dialogflow API

An end-to-end development suite for conversational interfaces (e.g., chatbots, 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

#initialize ⇒ DialogflowService

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

#key ⇒ String

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

Returns:

  • (String) —

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



39
40
41
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



44
45
46
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



299
300
301
302
303
304
305
306
307
308
309
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 299

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 (extends the existing collection of entries). 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



572
573
574
575
576
577
578
579
580
581
582
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 572

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



608
609
610
611
612
613
614
615
616
617
618
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 608

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 entities in the specified entity type (replaces the existing collection of entries). Operation

Parameters:

  • parent (String) —

    Required. The name of the entity type to update the 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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



645
646
647
648
649
650
651
652
653
654
655
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 645

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



335
336
337
338
339
340
341
342
343
344
345
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 335

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



680
681
682
683
684
685
686
687
688
689
690
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 680

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



715
716
717
718
719
720
721
722
723
724
725
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 715

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

#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) —

    Optional. The language of entity synonyms defined in entity_type. If not specified, the agent's default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 375

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

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

  • language_code (String) —

    Optional. The language of training phrases, parameters and rich messages defined in intent. If not specified, the agent's default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



757
758
759
760
761
762
763
764
765
766
767
768
769
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 757

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.

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1033

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.

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1204

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

#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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



409
410
411
412
413
414
415
416
417
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 409

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

Deletes the specified intent.

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



792
793
794
795
796
797
798
799
800
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 792

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1066

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



961
962
963
964
965
966
967
968
969
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 961

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.

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1238

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 999

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



72
73
74
75
76
77
78
79
80
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 72

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) —

    Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



446
447
448
449
450
451
452
453
454
455
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 446

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

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

  • language_code (String) —

    Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1097
1098
1099
1100
1101
1102
1103
1104
1105
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1097

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.

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1270
1271
1272
1273
1274
1275
1276
1277
1278
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1270

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

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1378
1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1378

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



145
146
147
148
149
150
151
152
153
154
155
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 145

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) —

    Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

  • page_size (Fixnum) —

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

  • page_token (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 489

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

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

  • language_code (String) —

    Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent before they can be used.

  • page_size (Fixnum) —

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

  • page_token (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 877

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) —

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

  • page_token (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1133

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.

Parameters:

  • parent (String) —

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

  • page_size (Fixnum) —

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

  • page_token (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1306

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

#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) —

    Required for all methods except create (create populates the name automatically. The unique identifier of the entity type. 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) —

    Optional. The language of entity synonyms defined in entity_type. If not specified, the agent's default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

  • update_mask (String) —

    Optional. The mask to control which fields get updated.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 534

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

    Required for all methods except create (create populates the name automatically. The unique identifier of this intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

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

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

  • language_code (String) —

    Optional. The language of training phrases, parameters and rich messages defined in intent. If not specified, the agent's default language is used. More than a dozen languages are supported. Note: languages must be enabled in the agent, before they can be used.

  • update_mask (String) —

    Optional. The mask to control which fields get updated.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



925
926
927
928
929
930
931
932
933
934
935
936
937
938
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 925

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

  • google_cloud_dialogflow_v2_context_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context) (defaults to: nil)
  • update_mask (String) —

    Optional. The mask to control which fields get updated.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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.

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

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

    Optional. The mask to control which fields get updated.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 1343

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

#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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



183
184
185
186
187
188
189
190
191
192
193
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 183

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) —

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

  • page_token (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



227
228
229
230
231
232
233
234
235
236
237
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 227

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) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



263
264
265
266
267
268
269
270
271
272
273
 
# File 'generated/google/apis/dialogflow_v2/service.rb', line 263

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