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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/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:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeDialogflowService

Returns a new instance of DialogflowService.



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

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

Instance Attribute Details

#keyString

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

Returns:

  • (String)

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



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

def key
  @key
end

#quota_userString

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

Returns:

  • (String)

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



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

def quota_user
  @quota_user
end

Instance Method Details

#analyze_project_conversation_participant_content(participant, google_cloud_dialogflow_v2_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameters:

  • participant (String)

    Required. The name of the participant this text comes from. Format: projects// locations//conversations//participants/.

  • google_cloud_dialogflow_v2_analyze_content_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3985

def analyze_project_conversation_participant_content(participant, google_cloud_dialogflow_v2_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+participant}:analyzeContent', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_analyze_content_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse
  command.params['participant'] = participant unless participant.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#analyze_project_location_conversation_participant_content(participant, google_cloud_dialogflow_v2_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameters:

  • participant (String)

    Required. The name of the participant this text comes from. Format: projects// locations//conversations//participants/.

  • google_cloud_dialogflow_v2_analyze_content_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8579

def analyze_project_location_conversation_participant_content(participant, google_cloud_dialogflow_v2_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+participant}:analyzeContent', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_analyze_content_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnalyzeContentResponse
  command.params['participant'] = participant unless participant.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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the agent to delete all entities types for. Format: projects//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



509
510
511
512
513
514
515
516
517
518
519
# File 'lib/google/apis/dialogflow_v2/service.rb', line 509

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. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: An empty Struct message - response : An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the entity type to create entities in. Format: projects/ /agent/entityTypes/.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the entity type to delete entries for. Format: projects/ /agent/entityTypes/.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



833
834
835
836
837
838
839
840
841
842
843
# File 'lib/google/apis/dialogflow_v2/service.rb', line 833

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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the entity type to update or create entities in. Format: projects//agent/entityTypes/.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: An empty Struct message - response : BatchUpdateEntityTypesResponse Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the agent to update or create entity types in. Format: projects//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



550
551
552
553
554
555
556
557
558
559
560
# File 'lib/google/apis/dialogflow_v2/service.rb', line 550

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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the agent to delete all entities types for. Format: projects//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1665

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. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: An empty Struct message - response : BatchUpdateIntentsResponse Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the agent to update or create intents in. Format: projects//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1706

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

#batch_project_location_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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the agent to delete all entities types for. Format: projects//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5422

def batch_project_location_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_location_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. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: An empty Struct message - response : An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the entity type to create entities in. Format: projects/ /agent/entityTypes/.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5704

def batch_project_location_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_location_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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the entity type to delete entries for. Format: projects/ /agent/entityTypes/.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5746

def batch_project_location_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_location_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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the entity type to update or create entities in. Format: projects//agent/entityTypes/.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5789

def batch_project_location_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_location_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. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: An empty Struct message - response : BatchUpdateEntityTypesResponse Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the agent to update or create entity types in. Format: projects//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5463

def batch_project_location_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_location_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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the agent to delete all entities types for. Format: projects//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6578

def batch_project_location_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_location_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. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: An empty Struct message - response : BatchUpdateIntentsResponse Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The name of the agent to update or create intents in. Format: projects//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6619

def batch_project_location_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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9615
9616
9617
9618
9619
9620
9621
9622
9623
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9615

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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9827
9828
9829
9830
9831
9832
9833
9834
9835
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9827

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

#clear_project_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2_clear_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Clears a suggestion feature from a conversation profile for the given participant role. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ClearSuggestionFeatureConfigOperationMetadata - response: ConversationProfile

Parameters:

  • conversation_profile (String)

    Required. The Conversation Profile to add or update the suggestion feature config. Format: projects//locations//conversationProfiles/.

  • google_cloud_dialogflow_v2_clear_suggestion_feature_config_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ClearSuggestionFeatureConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def clear_project_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2_clear_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+conversationProfile}:clearSuggestionFeatureConfig', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ClearSuggestionFeatureConfigRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_clear_suggestion_feature_config_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
  command.params['conversationProfile'] = conversation_profile unless conversation_profile.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#clear_project_location_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2_clear_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Clears a suggestion feature from a conversation profile for the given participant role. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ClearSuggestionFeatureConfigOperationMetadata - response: ConversationProfile

Parameters:

  • conversation_profile (String)

    Required. The Conversation Profile to add or update the suggestion feature config. Format: projects//locations//conversationProfiles/.

  • google_cloud_dialogflow_v2_clear_suggestion_feature_config_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ClearSuggestionFeatureConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8107

def clear_project_location_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2_clear_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+conversationProfile}:clearSuggestionFeatureConfig', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ClearSuggestionFeatureConfigRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_clear_suggestion_feature_config_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
  command.params['conversationProfile'] = conversation_profile unless conversation_profile.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#complete_project_conversation(name, google_cloud_dialogflow_v2_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

Parameters:

  • name (String)

    Required. Resource identifier of the conversation to close. Format: projects// locations//conversations/.

  • google_cloud_dialogflow_v2_complete_conversation_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CompleteConversationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3767

def complete_project_conversation(name, google_cloud_dialogflow_v2_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:complete', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CompleteConversationRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_complete_conversation_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
  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

#complete_project_location_conversation(name, google_cloud_dialogflow_v2_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

Parameters:

  • name (String)

    Required. Resource identifier of the conversation to close. Format: projects// locations//conversations/.

  • google_cloud_dialogflow_v2_complete_conversation_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CompleteConversationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8361

def complete_project_location_conversation(name, google_cloud_dialogflow_v2_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:complete', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CompleteConversationRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_complete_conversation_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
  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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

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

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

    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



590
591
592
593
594
595
596
597
598
599
600
601
# File 'lib/google/apis/dialogflow_v2/service.rb', line 590

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 an environment for. Supported formats: - projects//agent - projects//locations//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



912
913
914
915
916
917
918
919
920
921
922
923
# File 'lib/google/apis/dialogflow_v2/service.rb', line 912

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_environment_user_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//agent/ sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def create_project_agent_environment_user_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_environment_user_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// agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1468

def create_project_agent_environment_user_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_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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The agent to create a intent for. Format: projects//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 used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1748

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_knowledge_basis(parent, google_cloud_dialogflow_v2_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase

Creates a knowledge base.

Parameters:

  • parent (String)

    Required. The project to create a knowledge base for. Format: projects// locations/.

  • google_cloud_dialogflow_v2_knowledge_base_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def create_project_agent_knowledge_basis(parent, google_cloud_dialogflow_v2_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/knowledgeBases', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
  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_knowledge_basis_document(parent, google_cloud_dialogflow_v2_document_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Parameters:

  • parent (String)

    Required. The knowledge base to create a document for. Format: projects// locations//knowledgeBases/.

  • google_cloud_dialogflow_v2_document_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2150

def create_project_agent_knowledge_basis_document(parent, google_cloud_dialogflow_v2_document_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/documents', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document::Representation
  command.request_object = google_cloud_dialogflow_v2_document_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_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//agent/ sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2471

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// agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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. The new version points to the agent instance in the " default" environment.

Parameters:

  • parent (String)

    Required. The agent to create a version for. Supported formats: - projects// agent - projects//locations//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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

#create_project_conversation(parent, google_cloud_dialogflow_v2_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation

Creates a new conversation. Conversations are auto-completed after 24 hours. Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage. For Automated Agent Stage, there will be a dialogflow agent responding to user queries. For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation. If Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from Automated Agent Stage, otherwise, it will start from Assist Stage. And during Automated Agent Stage, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage.

Parameters:

  • parent (String)

    Required. Resource identifier of the project creating the conversation. Format: projects//locations/.

  • google_cloud_dialogflow_v2_conversation_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation) (defaults to: nil)
  • conversation_id (String) (defaults to: nil)

    Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto- generated one to you. The conversation ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3818

def create_project_conversation(parent, google_cloud_dialogflow_v2_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/conversations', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
  command.request_object = google_cloud_dialogflow_v2_conversation_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
  command.params['parent'] = parent unless parent.nil?
  command.query['conversationId'] = conversation_id unless conversation_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_conversation_model(parent, google_cloud_dialogflow_v2_conversation_model_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Creates a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateConversationModelOperationMetadata - response: ConversationModel

Parameters:

  • parent (String)

    The project to create conversation model for. Format: projects/

  • google_cloud_dialogflow_v2_conversation_model_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationModel) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def create_project_conversation_model(parent, google_cloud_dialogflow_v2_conversation_model_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/conversationModels', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationModel::Representation
  command.request_object = google_cloud_dialogflow_v2_conversation_model_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_conversation_participant(parent, google_cloud_dialogflow_v2_participant_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant

Creates a new participant in a conversation.

Parameters:

  • parent (String)

    Required. Resource identifier of the conversation adding the participant. Format: projects//locations//conversations/.

  • google_cloud_dialogflow_v2_participant_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4019

def create_project_conversation_participant(parent, google_cloud_dialogflow_v2_participant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/participants', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
  command.request_object = google_cloud_dialogflow_v2_participant_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant
  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_conversation_profile(parent, google_cloud_dialogflow_v2_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile

Creates a conversation profile in the specified project. ConversationProfile. CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.

Parameters:

  • parent (String)

    Required. The project to create a conversation profile for. Format: projects// locations/.

  • google_cloud_dialogflow_v2_conversation_profile_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def create_project_conversation_profile(parent, google_cloud_dialogflow_v2_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/conversationProfiles', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
  command.request_object = google_cloud_dialogflow_v2_conversation_profile_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile
  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_generator(parent, google_cloud_dialogflow_v2_generator_object = nil, generator_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator

Creates a generator.

Parameters:

  • parent (String)

    Required. The project/location to create generator for. Format: projects// locations/

  • google_cloud_dialogflow_v2_generator_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator) (defaults to: nil)
  • generator_id (String) (defaults to: nil)

    Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3, 64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4340

def create_project_generator(parent, google_cloud_dialogflow_v2_generator_object = nil, generator_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/generators', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator::Representation
  command.request_object = google_cloud_dialogflow_v2_generator_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator
  command.params['parent'] = parent unless parent.nil?
  command.query['generatorId'] = generator_id unless generator_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_knowledge_basis(parent, google_cloud_dialogflow_v2_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase

Creates a knowledge base.

Parameters:

  • parent (String)

    Required. The project to create a knowledge base for. Format: projects// locations/.

  • google_cloud_dialogflow_v2_knowledge_base_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def create_project_knowledge_basis(parent, google_cloud_dialogflow_v2_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/knowledgeBases', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
  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_knowledge_basis_document(parent, google_cloud_dialogflow_v2_document_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Parameters:

  • parent (String)

    Required. The knowledge base to create a document for. Format: projects// locations//knowledgeBases/.

  • google_cloud_dialogflow_v2_document_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4607

def create_project_knowledge_basis_document(parent, google_cloud_dialogflow_v2_document_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/documents', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document::Representation
  command.request_object = google_cloud_dialogflow_v2_document_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_location_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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

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

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

    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5503

def create_project_location_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_location_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 an environment for. Supported formats: - projects//agent - projects//locations//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5825

def create_project_location_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_location_agent_environment_user_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//agent/ sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6192

def create_project_location_agent_environment_user_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_location_agent_environment_user_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// agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6381

def create_project_location_agent_environment_user_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_location_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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The agent to create a intent for. Format: projects//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 used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6661

def create_project_location_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_location_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//agent/ sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6957

def create_project_location_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_location_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// agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7146

def create_project_location_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_location_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. The new version points to the agent instance in the " default" environment.

Parameters:

  • parent (String)

    Required. The agent to create a version for. Supported formats: - projects// agent - projects//locations//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7336

def create_project_location_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

#create_project_location_conversation(parent, google_cloud_dialogflow_v2_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation

Creates a new conversation. Conversations are auto-completed after 24 hours. Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage. For Automated Agent Stage, there will be a dialogflow agent responding to user queries. For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation. If Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from Automated Agent Stage, otherwise, it will start from Assist Stage. And during Automated Agent Stage, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage.

Parameters:

  • parent (String)

    Required. Resource identifier of the project creating the conversation. Format: projects//locations/.

  • google_cloud_dialogflow_v2_conversation_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation) (defaults to: nil)
  • conversation_id (String) (defaults to: nil)

    Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto- generated one to you. The conversation ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8412

def create_project_location_conversation(parent, google_cloud_dialogflow_v2_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/conversations', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
  command.request_object = google_cloud_dialogflow_v2_conversation_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
  command.params['parent'] = parent unless parent.nil?
  command.query['conversationId'] = conversation_id unless conversation_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_location_conversation_dataset(parent, google_cloud_dialogflow_v2_conversation_dataset_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Creates a new conversation dataset. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateConversationDatasetOperationMetadata - response: ConversationDataset

Parameters:

  • parent (String)

    Required. The project to create conversation dataset for. Format: projects// locations/

  • google_cloud_dialogflow_v2_conversation_dataset_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationDataset) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7596

def create_project_location_conversation_dataset(parent, google_cloud_dialogflow_v2_conversation_dataset_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/conversationDatasets', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationDataset::Representation
  command.request_object = google_cloud_dialogflow_v2_conversation_dataset_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_location_conversation_model(parent, google_cloud_dialogflow_v2_conversation_model_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Creates a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateConversationModelOperationMetadata - response: ConversationModel

Parameters:

  • parent (String)

    The project to create conversation model for. Format: projects/

  • google_cloud_dialogflow_v2_conversation_model_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationModel) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7778

def create_project_location_conversation_model(parent, google_cloud_dialogflow_v2_conversation_model_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/conversationModels', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationModel::Representation
  command.request_object = google_cloud_dialogflow_v2_conversation_model_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_location_conversation_model_evaluation(parent, google_cloud_dialogflow_v2_create_conversation_model_evaluation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Creates evaluation of a conversation model.

Parameters:

  • parent (String)

    Required. The conversation model resource name. Format: projects//locations// conversationModels/

  • google_cloud_dialogflow_v2_create_conversation_model_evaluation_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CreateConversationModelEvaluationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7999

def create_project_location_conversation_model_evaluation(parent, google_cloud_dialogflow_v2_create_conversation_model_evaluation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/evaluations', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2CreateConversationModelEvaluationRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_create_conversation_model_evaluation_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_location_conversation_participant(parent, google_cloud_dialogflow_v2_participant_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant

Creates a new participant in a conversation.

Parameters:

  • parent (String)

    Required. Resource identifier of the conversation adding the participant. Format: projects//locations//conversations/.

  • google_cloud_dialogflow_v2_participant_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8613

def create_project_location_conversation_participant(parent, google_cloud_dialogflow_v2_participant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/participants', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
  command.request_object = google_cloud_dialogflow_v2_participant_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_conversation_profile(parent, google_cloud_dialogflow_v2_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile

Creates a conversation profile in the specified project. ConversationProfile. CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.

Parameters:

  • parent (String)

    Required. The project to create a conversation profile for. Format: projects// locations/.

  • google_cloud_dialogflow_v2_conversation_profile_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8143

def create_project_location_conversation_profile(parent, google_cloud_dialogflow_v2_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/conversationProfiles', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
  command.request_object = google_cloud_dialogflow_v2_conversation_profile_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_generator(parent, google_cloud_dialogflow_v2_generator_object = nil, generator_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator

Creates a generator.

Parameters:

  • parent (String)

    Required. The project/location to create generator for. Format: projects// locations/

  • google_cloud_dialogflow_v2_generator_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator) (defaults to: nil)
  • generator_id (String) (defaults to: nil)

    Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula a-zA-Z* with the characters length in range of [3, 64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8934

def create_project_location_generator(parent, google_cloud_dialogflow_v2_generator_object = nil, generator_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/generators', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator::Representation
  command.request_object = google_cloud_dialogflow_v2_generator_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator
  command.params['parent'] = parent unless parent.nil?
  command.query['generatorId'] = generator_id unless generator_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_location_knowledge_basis(parent, google_cloud_dialogflow_v2_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase

Creates a knowledge base.

Parameters:

  • parent (String)

    Required. The project to create a knowledge base for. Format: projects// locations/.

  • google_cloud_dialogflow_v2_knowledge_base_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9106

def create_project_location_knowledge_basis(parent, google_cloud_dialogflow_v2_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/knowledgeBases', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Parameters:

  • parent (String)

    Required. The knowledge base to create a document for. Format: projects// locations//knowledgeBases/.

  • google_cloud_dialogflow_v2_document_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9300

def create_project_location_knowledge_basis_document(parent, google_cloud_dialogflow_v2_document_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/documents', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document::Representation
  command.request_object = google_cloud_dialogflow_v2_document_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

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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//agent/ environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



947
948
949
950
951
952
953
954
955
# File 'lib/google/apis/dialogflow_v2/service.rb', line 947

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_environment_user_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//agent/sessions/ /contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def delete_project_agent_environment_user_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_environment_user_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//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1192
1193
1194
1195
1196
1197
1198
1199
1200
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1192

def delete_project_agent_environment_user_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_environment_user_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//agent/ sessions//entityTypes/ or projects//agent/environments//users//sessions// entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1505
1506
1507
1508
1509
1510
1511
1512
1513
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1505

def delete_project_agent_environment_user_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

#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. Note: You should always train an agent prior to sending it queries. See the training documentation.

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1786
1787
1788
1789
1790
1791
1792
1793
1794
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1786

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

Deletes the specified knowledge base.

Parameters:

  • name (String)

    Required. The name of the knowledge base to delete. Format: projects// locations//knowledgeBases/.

  • force (Boolean) (defaults to: nil)

    Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1992

def delete_project_agent_knowledge_basis(name, force: nil, 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['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Deletes the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: An Empty message

Parameters:

  • name (String)

    Required. The name of the document to delete. Format: projects//locations// knowledgeBases//documents/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2187
2188
2189
2190
2191
2192
2193
2194
2195
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2187

def delete_project_agent_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '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

#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//agent/sessions/ /contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2506
2507
2508
2509
2510
2511
2512
2513
2514
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2506

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//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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//agent/ sessions//entityTypes/ or projects//agent/environments//users//sessions// entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2697
2698
2699
2700
2701
2702
2703
2704
2705
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2697

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

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

Delete the specified agent version.

Parameters:

  • name (String)

    Required. The name of the version to delete. Supported formats: - projects// agent/versions/ - projects//locations//agent/versions/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2883
2884
2885
2886
2887
2888
2889
2890
2891
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2883

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

Deletes a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeleteConversationModelOperationMetadata - response: An Empty message

Parameters:

  • name (String)

    Required. The conversation model to delete. Format: projects// conversationModels/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def delete_project_conversation_model(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '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

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

Deletes the specified conversation profile.

Parameters:

  • name (String)

    Required. The name of the conversation profile to delete. Format: projects// locations//conversationProfiles/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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

Deletes the specified knowledge base.

Parameters:

  • name (String)

    Required. The name of the knowledge base to delete. Format: projects// locations//knowledgeBases/.

  • force (Boolean) (defaults to: nil)

    Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def delete_project_knowledge_basis(name, force: nil, 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['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Deletes the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: An Empty message

Parameters:

  • name (String)

    Required. The name of the document to delete. Format: projects//locations// knowledgeBases//documents/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4644
4645
4646
4647
4648
4649
4650
4651
4652
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4644

def delete_project_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '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

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4916
4917
4918
4919
4920
4921
4922
4923
4924
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4916

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

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

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5539
5540
5541
5542
5543
5544
5545
5546
5547
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5539

def delete_project_location_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_location_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//agent/ environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5860
5861
5862
5863
5864
5865
5866
5867
5868
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5860

def delete_project_location_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_location_agent_environment_user_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//agent/sessions/ /contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6227
6228
6229
6230
6231
6232
6233
6234
6235
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6227

def delete_project_location_agent_environment_user_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_location_agent_environment_user_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//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6105
6106
6107
6108
6109
6110
6111
6112
6113
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6105

def delete_project_location_agent_environment_user_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_location_agent_environment_user_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//agent/ sessions//entityTypes/ or projects//agent/environments//users//sessions// entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6418
6419
6420
6421
6422
6423
6424
6425
6426
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6418

def delete_project_location_agent_environment_user_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

#delete_project_location_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. Note: You should always train an agent prior to sending it queries. See the training documentation.

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6699
6700
6701
6702
6703
6704
6705
6706
6707
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6699

def delete_project_location_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_location_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//agent/sessions/ /contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6992
6993
6994
6995
6996
6997
6998
6999
7000
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6992

def delete_project_location_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_location_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//agent/sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6870
6871
6872
6873
6874
6875
6876
6877
6878
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6870

def delete_project_location_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_location_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//agent/ sessions//entityTypes/ or projects//agent/environments//users//sessions// entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7183
7184
7185
7186
7187
7188
7189
7190
7191
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7183

def delete_project_location_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

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

Delete the specified agent version.

Parameters:

  • name (String)

    Required. The name of the version to delete. Supported formats: - projects// agent/versions/ - projects//locations//agent/versions/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7369
7370
7371
7372
7373
7374
7375
7376
7377
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7369

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

Deletes the specified conversation dataset. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeleteConversationDatasetOperationMetadata - response: An Empty message

Parameters:

  • name (String)

    Required. The conversation dataset to delete. Format: projects//locations// conversationDatasets/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7634
7635
7636
7637
7638
7639
7640
7641
7642
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7634

def delete_project_location_conversation_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '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

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

Deletes a model. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeleteConversationModelOperationMetadata - response: An Empty message

Parameters:

  • name (String)

    Required. The conversation model to delete. Format: projects// conversationModels/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7816
7817
7818
7819
7820
7821
7822
7823
7824
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7816

def delete_project_location_conversation_model(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '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

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

Deletes the specified conversation profile.

Parameters:

  • name (String)

    Required. The name of the conversation profile to delete. Format: projects// locations//conversationProfiles/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8176
8177
8178
8179
8180
8181
8182
8183
8184
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8176

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

Deletes a generator.

Parameters:

  • name (String)

    Required. The generator resource name to delete. Format: projects//locations// generators/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8968
8969
8970
8971
8972
8973
8974
8975
8976
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8968

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

Deletes the specified knowledge base.

Parameters:

  • name (String)

    Required. The name of the knowledge base to delete. Format: projects// locations//knowledgeBases/.

  • force (Boolean) (defaults to: nil)

    Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9142

def delete_project_location_knowledge_basis(name, force: nil, 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['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Deletes the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: An Empty message

Parameters:

  • name (String)

    Required. The name of the document to delete. Format: projects//locations// knowledgeBases//documents/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9337
9338
9339
9340
9341
9342
9343
9344
9345
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9337

def delete_project_location_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, '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

#deploy_project_conversation_model(name, google_cloud_dialogflow_v2_deploy_conversation_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployConversationModelOperationMetadata

Parameters:

  • name (String)

    Required. The conversation model to deploy. Format: projects// conversationModels/

  • google_cloud_dialogflow_v2_deploy_conversation_model_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DeployConversationModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def deploy_project_conversation_model(name, google_cloud_dialogflow_v2_deploy_conversation_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:deploy', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DeployConversationModelRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_deploy_conversation_model_request_object
  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

#deploy_project_location_conversation_model(name, google_cloud_dialogflow_v2_deploy_conversation_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployConversationModelOperationMetadata

Parameters:

  • name (String)

    Required. The conversation model to deploy. Format: projects// conversationModels/

  • google_cloud_dialogflow_v2_deploy_conversation_model_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DeployConversationModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7855

def deploy_project_location_conversation_model(name, google_cloud_dialogflow_v2_deploy_conversation_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:deploy', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DeployConversationModelRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_deploy_conversation_model_request_object
  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

#detect_project_agent_environment_user_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. If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of DetectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products. Note: Always use agent versions for production traffic. See Versions and environments.

Parameters:

  • session (String)

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def detect_project_agent_environment_user_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

#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. If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of DetectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products. Note: Always use agent versions for production traffic. See Versions and environments.

Parameters:

  • session (String)

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2434

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

#detect_project_location_agent_environment_user_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. If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of DetectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products. Note: Always use agent versions for production traffic. See Versions and environments.

Parameters:

  • session (String)

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6155

def detect_project_location_agent_environment_user_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

#detect_project_location_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. If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of DetectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products. Note: Always use agent versions for production traffic. See Versions and environments.

Parameters:

  • session (String)

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6920

def detect_project_location_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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: ExportAgentResponse

Parameters:

  • parent (String)

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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

#export_project_knowledge_basis_document(name, google_cloud_dialogflow_v2_export_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Exports a smart messaging candidate document into the specified destination. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Parameters:

  • name (String)

    Required. The name of the document to export. Format: projects//locations// knowledgeBases//documents/.

  • google_cloud_dialogflow_v2_export_document_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4680

def export_project_knowledge_basis_document(name, google_cloud_dialogflow_v2_export_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:export', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_export_document_request_object
  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

#export_project_location_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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: ExportAgentResponse

Parameters:

  • parent (String)

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5095

def export_project_location_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

#export_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2_export_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Exports a smart messaging candidate document into the specified destination. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Parameters:

  • name (String)

    Required. The name of the document to export. Format: projects//locations// knowledgeBases//documents/.

  • google_cloud_dialogflow_v2_export_document_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9373

def export_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2_export_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:export', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportDocumentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_export_document_request_object
  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

#generate_project_location_stateless_suggestion(parent, google_cloud_dialogflow_v2_generate_stateless_suggestion_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSuggestionResponse

Generates and returns a suggestion for a conversation that does not have a resource created for it.

Parameters:

  • parent (String)

    Required. The parent resource to charge for the Suggestion's generation. Format: projects//locations/.

  • google_cloud_dialogflow_v2_generate_stateless_suggestion_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9719

def generate_project_location_stateless_suggestion(parent, google_cloud_dialogflow_v2_generate_stateless_suggestion_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/statelessSuggestion:generate', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_generate_stateless_suggestion_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSuggestionResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSuggestionResponse
  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

#generate_project_location_suggestion_stateless_summary(parent, google_cloud_dialogflow_v2_generate_stateless_summary_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSummaryResponse

Generates and returns a summary for a conversation that does not have a resource created for it.

Parameters:

  • parent (String)

    Required. The parent resource to charge for the Summary's generation. Format: projects//locations/.

  • google_cloud_dialogflow_v2_generate_stateless_summary_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSummaryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9754

def generate_project_location_suggestion_stateless_summary(parent, google_cloud_dialogflow_v2_generate_stateless_summary_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/suggestions:generateStatelessSummary', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSummaryRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_generate_stateless_summary_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSummaryResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSummaryResponse
  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

#generate_project_suggestion_stateless_summary(parent, google_cloud_dialogflow_v2_generate_stateless_summary_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSummaryResponse

Generates and returns a summary for a conversation that does not have a resource created for it.

Parameters:

  • parent (String)

    Required. The parent resource to charge for the Summary's generation. Format: projects//locations/.

  • google_cloud_dialogflow_v2_generate_stateless_summary_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSummaryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9931

def generate_project_suggestion_stateless_summary(parent, google_cloud_dialogflow_v2_generate_stateless_summary_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/suggestions:generateStatelessSummary', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSummaryRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_generate_stateless_summary_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSummaryResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GenerateStatelessSummaryResponse
  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/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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

  • language_code (String) (defaults to: nil)

    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



661
662
663
664
665
666
667
668
669
670
# File 'lib/google/apis/dialogflow_v2/service.rb', line 661

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. Supported formats: - projects//agent/ environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



979
980
981
982
983
984
985
986
987
# File 'lib/google/apis/dialogflow_v2/service.rb', line 979

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. Supported formats: - projects//agent/environments/ - projects//locations//agent/ environments/ The environment ID for the default environment is -.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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_environment_user_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//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def get_project_agent_environment_user_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_environment_user_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//agent/ sessions//entityTypes/ or projects//agent/environments//users//sessions// entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1540
1541
1542
1543
1544
1545
1546
1547
1548
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1540

def get_project_agent_environment_user_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_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//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



214
215
216
217
218
219
220
221
222
# File 'lib/google/apis/dialogflow_v2/service.rb', line 214

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

  • 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 used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1823

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

Retrieves the specified knowledge base.

Parameters:

  • name (String)

    Required. The name of the knowledge base to retrieve. Format projects// locations//knowledgeBases/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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

Retrieves the specified document.

Parameters:

  • name (String)

    Required. The name of the document to retrieve. Format projects//locations// knowledgeBases//documents/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2218
2219
2220
2221
2222
2223
2224
2225
2226
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2218

def get_project_agent_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document
  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_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//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2539
2540
2541
2542
2543
2544
2545
2546
2547
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2539

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//agent/ sessions//entityTypes/ or projects//agent/environments//users//sessions// entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2732
2733
2734
2735
2736
2737
2738
2739
2740
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2732

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



250
251
252
253
254
255
256
257
258
259
# File 'lib/google/apis/dialogflow_v2/service.rb', line 250

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. Supported formats: - projects//agent/ versions/ - projects//locations//agent/versions/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2914
2915
2916
2917
2918
2919
2920
2921
2922
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2914

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

Retrieves the specific conversation.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3852
3853
3854
3855
3856
3857
3858
3859
3860
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3852

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

Retrieves the specified conversation dataset.

Parameters:

  • name (String)

    Required. The conversation dataset to retrieve. Format: projects//locations// conversationDatasets/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3105
3106
3107
3108
3109
3110
3111
3112
3113
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3105

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

Gets conversation model.

Parameters:

  • name (String)

    Required. The conversation model to retrieve. Format: projects// conversationModels/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3328
3329
3330
3331
3332
3333
3334
3335
3336
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3328

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

Gets an evaluation of conversation model.

Parameters:

  • name (String)

    Required. The conversation model evaluation resource name. Format: projects// conversationModels//evaluations/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3438

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

Retrieves a conversation participant.

Parameters:

  • name (String)

    Required. The name of the participant. Format: projects//locations// conversations//participants/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4052
4053
4054
4055
4056
4057
4058
4059
4060
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4052

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

Retrieves the specified conversation profile.

Parameters:

  • name (String)

    Required. The resource name of the conversation profile. Format: projects// locations//conversationProfiles/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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

Retrieves the specified knowledge base.

Parameters:

  • name (String)

    Required. The name of the knowledge base to retrieve. Format projects// locations//knowledgeBases/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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

Retrieves the specified document.

Parameters:

  • name (String)

    Required. The name of the document to retrieve. Format projects//locations// knowledgeBases//documents/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4713
4714
4715
4716
4717
4718
4719
4720
4721
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4713

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

Gets information about a location.

Parameters:

  • name (String)

    Resource name for the location.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4946
4947
4948
4949
4950
4951
4952
4953
4954
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4946

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

#get_project_location_agent(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/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4977
4978
4979
4980
4981
4982
4983
4984
4985
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4977

def get_project_location_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_location_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//agent/entityTypes/.

  • language_code (String) (defaults to: nil)

    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5574

def get_project_location_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_location_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. Supported formats: - projects//agent/ environments/ - projects//locations//agent/environments/ The environment ID for the default environment is -.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5892
5893
5894
5895
5896
5897
5898
5899
5900
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5892

def get_project_location_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_location_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. Supported formats: - projects//agent/environments/ - projects//locations//agent/ environments/ The environment ID for the default environment is -.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5929

def get_project_location_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_location_agent_environment_user_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//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6260
6261
6262
6263
6264
6265
6266
6267
6268
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6260

def get_project_location_agent_environment_user_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_location_agent_environment_user_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//agent/ sessions//entityTypes/ or projects//agent/environments//users//sessions// entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6453
6454
6455
6456
6457
6458
6459
6460
6461
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6453

def get_project_location_agent_environment_user_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_location_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//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5127
5128
5129
5130
5131
5132
5133
5134
5135
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5127

def get_project_location_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_location_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//agent/intents/.

  • 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 used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6736

def get_project_location_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_location_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//agent/sessions//contexts/ or projects//agent/environments//users//sessions//contexts/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7025
7026
7027
7028
7029
7030
7031
7032
7033
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7025

def get_project_location_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_location_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//agent/ sessions//entityTypes/ or projects//agent/environments//users//sessions// entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7218
7219
7220
7221
7222
7223
7224
7225
7226
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7218

def get_project_location_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_location_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/.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5163

def get_project_location_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_location_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. Supported formats: - projects//agent/ versions/ - projects//locations//agent/versions/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7400
7401
7402
7403
7404
7405
7406
7407
7408
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7400

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

Retrieves the specific conversation.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8446

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

Retrieves the specified conversation dataset.

Parameters:

  • name (String)

    Required. The conversation dataset to retrieve. Format: projects//locations// conversationDatasets/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7665
7666
7667
7668
7669
7670
7671
7672
7673
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7665

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

Gets conversation model.

Parameters:

  • name (String)

    Required. The conversation model to retrieve. Format: projects// conversationModels/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7888
7889
7890
7891
7892
7893
7894
7895
7896
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7888

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

Gets an evaluation of conversation model.

Parameters:

  • name (String)

    Required. The conversation model evaluation resource name. Format: projects// conversationModels//evaluations/

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8032
8033
8034
8035
8036
8037
8038
8039
8040
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8032

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

Retrieves a conversation participant.

Parameters:

  • name (String)

    Required. The name of the participant. Format: projects//locations// conversations//participants/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8646
8647
8648
8649
8650
8651
8652
8653
8654
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8646

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

Retrieves the specified conversation profile.

Parameters:

  • name (String)

    Required. The resource name of the conversation profile. Format: projects// locations//conversationProfiles/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8207
8208
8209
8210
8211
8212
8213
8214
8215
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8207

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

Retrieves a generator.

Parameters:

  • name (String)

    Required. The generator resource name to retrieve. Format: projects// locations//generators/`

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8999
9000
9001
9002
9003
9004
9005
9006
9007
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8999

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

Retrieves the specified knowledge base.

Parameters:

  • name (String)

    Required. The name of the knowledge base to retrieve. Format projects// locations//knowledgeBases/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9174
9175
9176
9177
9178
9179
9180
9181
9182
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9174

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

Retrieves the specified document.

Parameters:

  • name (String)

    Required. The name of the document to retrieve. Format projects//locations// knowledgeBases//documents/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9406
9407
9408
9409
9410
9411
9412
9413
9414
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9406

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

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9646
9647
9648
9649
9650
9651
9652
9653
9654
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9646

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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9858
9859
9860
9861
9862
9863
9864
9865
9866
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9858

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. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message The operation only tracks when importing is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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

#import_project_conversation_dataset_conversation_data(name, google_cloud_dialogflow_v2_import_conversation_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportConversationDataOperationMetadata - response: ImportConversationDataOperationResponse

Parameters:

  • name (String)

    Required. Dataset resource name. Format: projects//locations// conversationDatasets/

  • google_cloud_dialogflow_v2_import_conversation_data_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportConversationDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def import_project_conversation_dataset_conversation_data(name, google_cloud_dialogflow_v2_import_conversation_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:importConversationData', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportConversationDataRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_import_conversation_data_request_object
  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_knowledge_basis_document(parent, google_cloud_dialogflow_v2_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

Parameters:

  • parent (String)

    Required. The knowledge base to import documents into. Format: projects// locations//knowledgeBases/.

  • google_cloud_dialogflow_v2_import_documents_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportDocumentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4750

def import_project_knowledge_basis_document(parent, google_cloud_dialogflow_v2_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/documents:import', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportDocumentsRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_import_documents_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

#import_project_location_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. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message The operation only tracks when importing is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5211

def import_project_location_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

#import_project_location_conversation_dataset_conversation_data(name, google_cloud_dialogflow_v2_import_conversation_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Import data into the specified conversation dataset. Note that it is not allowed to import data to a conversation dataset that already has data in it. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportConversationDataOperationMetadata - response: ImportConversationDataOperationResponse

Parameters:

  • name (String)

    Required. Dataset resource name. Format: projects//locations// conversationDatasets/

  • google_cloud_dialogflow_v2_import_conversation_data_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportConversationDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7703

def import_project_location_conversation_dataset_conversation_data(name, google_cloud_dialogflow_v2_import_conversation_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:importConversationData', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportConversationDataRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_import_conversation_data_request_object
  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_location_knowledge_basis_document(parent, google_cloud_dialogflow_v2_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

Parameters:

  • parent (String)

    Required. The knowledge base to import documents into. Format: projects// locations//knowledgeBases/.

  • google_cloud_dialogflow_v2_import_documents_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportDocumentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9443

def import_project_location_knowledge_basis_document(parent, google_cloud_dialogflow_v2_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/documents:import', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportDocumentsRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_import_documents_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//agent.

  • language_code (String) (defaults to: nil)

    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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_environment_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//agent or projects//locations//agent. Alternatively, you can specify the environment to list intents for. Format: projects//agent/environments/ or projects// locations//agent/environments/. Note: training phrases of the intents will not be returned for non-draft environment.

  • 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 used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1155

def list_project_agent_environment_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_environment_user_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//agent/ sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1385

def list_project_agent_environment_user_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_environment_user_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/ /agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1580

def list_project_agent_environment_user_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_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 non-default environments of the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list all environments from. Format: - projects//agent

    • projects//locations//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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//agent or projects//locations//agent. Alternatively, you can specify the environment to list intents for. Format: projects//agent/environments/ or projects// locations//agent/environments/. Note: training phrases of the intents will not be returned for non-draft environment.

  • 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 used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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_knowledge_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse

Returns the list of all knowledge bases of the specified agent.

Parameters:

  • parent (String)

    Required. The project to list of knowledge bases for. Format: projects// locations/.

  • filter (String) (defaults to: nil)

    The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains "articles". * ' display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2073

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

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

Returns the list of all documents of the knowledge base.

Parameters:

  • parent (String)

    Required. The knowledge base to list all documents for. Format: projects// locations//knowledgeBases/.

  • filter (String) (defaults to: nil)

    The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * " knowledge_types:FAQ" matches documents with FAQ knowledge type. * " display_name:customer" matches documents whose display name contains "customer" . * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2264

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

#list_project_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//agent/ sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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/ /agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2772

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. Supported formats: - projects// agent - projects//locations//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2950

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_answer_records(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListAnswerRecordsResponse

Returns the list of all answer records in the specified project in reverse chronological order.

Parameters:

  • parent (String)

    Required. The project to list all answer records for in reverse chronological order. Format: projects//locations/.

  • filter (String) (defaults to: nil)

    Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100.

  • page_token (String) (defaults to: nil)

    Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3034

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

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

Returns the list of all conversation datasets in the specified project and location.

Parameters:

  • parent (String)

    Required. The project and location name to list all conversation datasets for. Format: projects//locations/

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of conversation datasets to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def list_project_conversation_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/conversationDatasets', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationDatasetsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationDatasetsResponse
  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_conversation_messages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListMessagesResponse

Lists messages that belong to a given conversation. messages are ordered by create_time in descending order. To fetch updates without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token.

Parameters:

  • parent (String)

    Required. The name of the conversation to list messages for. Format: projects/ /locations//conversations/

  • filter (String) (defaults to: nil)

    Optional. Filter on message fields. Currently predicates on create_time and create_time_epoch_microseconds are supported. create_time only support milliseconds accuracy. E.g., create_time_epoch_microseconds > 1551790877964485 or create_time > 2017-01-15T01:30:15.01Z. For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3947

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

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

Lists evaluations of a conversation model.

Parameters:

  • parent (String)

    Required. The conversation model resource name. Format: projects// conversationModels/

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3474

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

Lists conversation models.

Parameters:

  • parent (String)

    Required. The project to list all conversation models for. Format: projects/

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of conversation models to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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

Returns the list of all participants in the specified conversation.

Parameters:

  • parent (String)

    Required. The conversation to list all participants from. Format: projects// locations//conversations/.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4088

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

Returns the list of all conversation profiles in the specified project.

Parameters:

  • parent (String)

    Required. The project to list all conversation profiles from. Format: projects//locations/.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def list_project_conversation_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/conversationProfiles', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse
  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_conversations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationsResponse

Returns the list of all conversations in the specified project.

Parameters:

  • parent (String)

    Required. The project from which to list all conversation. Format: projects// locations/.

  • filter (String) (defaults to: nil)

    A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: - The value must be a string, a number, or a boolean. - The comparison operator must be either =,!=, >, or <. - To filter on multiple expressions, separate the expressions with AND or OR (omitting both implies AND). - For clarity, expressions can be enclosed in parentheses. Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations: lifecycle_state = "COMPLETED" For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3899

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

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

Lists generators.

Parameters:

  • parent (String)

    Required. The project/location to list generators for. Format: projects// locations/

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of conversation models to return in a single page. Default to 10.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4379

def list_project_generators(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/generators', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListGeneratorsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListGeneratorsResponse
  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_knowledge_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse

Returns the list of all knowledge bases of the specified agent.

Parameters:

  • parent (String)

    Required. The project to list of knowledge bases for. Format: projects// locations/.

  • filter (String) (defaults to: nil)

    The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains "articles". * ' display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4530

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

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

Returns the list of all documents of the knowledge base.

Parameters:

  • parent (String)

    Required. The knowledge base to list all documents for. Format: projects// locations//knowledgeBases/.

  • filter (String) (defaults to: nil)

    The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * " knowledge_types:FAQ" matches documents with FAQ knowledge type. * " display_name:customer" matches documents whose display name contains "customer" . * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4798

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

#list_project_location_agent_entity_types(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::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//agent.

  • language_code (String) (defaults to: nil)

    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5615

def list_project_location_agent_entity_types(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '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_location_agent_environment_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//agent or projects//locations//agent. Alternatively, you can specify the environment to list intents for. Format: projects//agent/environments/ or projects// locations//agent/environments/. Note: training phrases of the intents will not be returned for non-draft environment.

  • 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 used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6068

def list_project_location_agent_environment_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_location_agent_environment_user_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//agent/ sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6298

def list_project_location_agent_environment_user_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_location_agent_environment_user_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/ /agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6493

def list_project_location_agent_environment_user_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_location_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 non-default environments of the specified agent.

Parameters:

  • parent (String)

    Required. The agent to list all environments from. Format: - projects//agent

    • projects//locations//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5967

def list_project_location_agent_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '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_location_agent_intents(parent, intent_view: nil, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::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//agent or projects//locations//agent. Alternatively, you can specify the environment to list intents for. Format: projects//agent/environments/ or projects// locations//agent/environments/. Note: training phrases of the intents will not be returned for non-draft environment.

  • 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 used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6784

def list_project_location_agent_intents(parent, intent_view: nil, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '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_location_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//agent/ sessions/ or projects//agent/environments//users//sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7063

def list_project_location_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_location_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/ /agent/sessions/ or projects//agent/environments//users// sessions/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7258

def list_project_location_agent_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, '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_location_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. Supported formats: - projects// agent - projects//locations//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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7436

def list_project_location_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_answer_records(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListAnswerRecordsResponse

Returns the list of all answer records in the specified project in reverse chronological order.

Parameters:

  • parent (String)

    Required. The project to list all answer records for in reverse chronological order. Format: projects//locations/.

  • filter (String) (defaults to: nil)

    Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100.

  • page_token (String) (defaults to: nil)

    Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7520

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

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

Returns the list of all conversation datasets in the specified project and location.

Parameters:

  • parent (String)

    Required. The project and location name to list all conversation datasets for. Format: projects//locations/

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of conversation datasets to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7742

def list_project_location_conversation_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/conversationDatasets', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationDatasetsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationDatasetsResponse
  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_conversation_messages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListMessagesResponse

Lists messages that belong to a given conversation. messages are ordered by create_time in descending order. To fetch updates without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token.

Parameters:

  • parent (String)

    Required. The name of the conversation to list messages for. Format: projects/ /locations//conversations/

  • filter (String) (defaults to: nil)

    Optional. Filter on message fields. Currently predicates on create_time and create_time_epoch_microseconds are supported. create_time only support milliseconds accuracy. E.g., create_time_epoch_microseconds > 1551790877964485 or create_time > 2017-01-15T01:30:15.01Z. For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8541

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

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

Lists evaluations of a conversation model.

Parameters:

  • parent (String)

    Required. The conversation model resource name. Format: projects// conversationModels/

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8068

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

Lists conversation models.

Parameters:

  • parent (String)

    Required. The project to list all conversation models for. Format: projects/

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of conversation models to return in a single page. By default 100 and at most 1000.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7923

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

Returns the list of all participants in the specified conversation.

Parameters:

  • parent (String)

    Required. The conversation to list all participants from. Format: projects// locations//conversations/.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8682

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

Returns the list of all conversation profiles in the specified project.

Parameters:

  • parent (String)

    Required. The project to list all conversation profiles from. Format: projects//locations/.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8243

def list_project_location_conversation_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/conversationProfiles', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationProfilesResponse
  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_conversations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListConversationsResponse

Returns the list of all conversations in the specified project.

Parameters:

  • parent (String)

    Required. The project from which to list all conversation. Format: projects// locations/.

  • filter (String) (defaults to: nil)

    A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: - The value must be a string, a number, or a boolean. - The comparison operator must be either =,!=, >, or <. - To filter on multiple expressions, separate the expressions with AND or OR (omitting both implies AND). - For clarity, expressions can be enclosed in parentheses. Only lifecycle_state can be filtered on in this way. For example, the following expression only returns COMPLETED conversations: lifecycle_state = "COMPLETED" For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8493

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

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

Lists generators.

Parameters:

  • parent (String)

    Required. The project/location to list generators for. Format: projects// locations/

  • page_size (Fixnum) (defaults to: nil)

    Optional. Maximum number of conversation models to return in a single page. Default to 10.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9035

def list_project_location_generators(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/generators', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListGeneratorsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListGeneratorsResponse
  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_knowledge_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ListKnowledgeBasesResponse

Returns the list of all knowledge bases of the specified agent.

Parameters:

  • parent (String)

    Required. The project to list of knowledge bases for. Format: projects// locations/.

  • filter (String) (defaults to: nil)

    The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains "articles". * ' display_name:"Best Articles"' matches knowledge bases whose display name contains "Best Articles". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains "articles" and whose language code is "en-gb". Note: An empty filter string (i.e. "") is a no-op and will result in no filtering. For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9223

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

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

Returns the list of all documents of the knowledge base.

Parameters:

  • parent (String)

    Required. The knowledge base to list all documents for. Format: projects// locations//knowledgeBases/.

  • filter (String) (defaults to: nil)

    The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * " knowledge_types:FAQ" matches documents with FAQ knowledge type. * " display_name:customer" matches documents whose display name contains "customer" . * "state=ACTIVE" matches documents with ACTIVE state. * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.

  • page_size (Fixnum) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

    The next_page_token value returned from a previous list request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9491

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

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

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9683

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_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudLocationListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • filter (String) (defaults to: nil)

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil)

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5017

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}/locations', options)
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudLocationListLocationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudLocationListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9895

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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    The unique identifier of the entity type. Required for EntityTypes. UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.

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

    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



747
748
749
750
751
752
753
754
755
756
757
758
759
# File 'lib/google/apis/dialogflow_v2/service.rb', line 747

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, allow_load_to_draft_and_discard_changes: 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 an 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 continues serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

Parameters:

  • name (String)

    Output only. The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/ environments/ The environment ID for the default environment is -.

  • google_cloud_dialogflow_v2_environment_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment) (defaults to: nil)
  • allow_load_to_draft_and_discard_changes (Boolean) (defaults to: nil)

    Optional. This field is used to prevent accidental overwrite of the default environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the default environment (environment ID = -).

  • update_mask (String) (defaults to: nil)

    Required. The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def patch_project_agent_environment(name, google_cloud_dialogflow_v2_environment_object = nil, allow_load_to_draft_and_discard_changes: 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['allowLoadToDraftAndDiscardChanges'] = allow_load_to_draft_and_discard_changes unless allow_load_to_draft_and_discard_changes.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_user_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//agent/ sessions//contexts/, or projects//agent/environments//users//sessions// contexts/. 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. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1428

def patch_project_agent_environment_user_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_environment_user_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/ /agent/sessions//entityTypes/, or projects//agent/environments//users// sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default ' -' user. `` 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1622

def patch_project_agent_environment_user_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_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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    Optional. The unique identifier of this intent. Required for Intents. UpdateIntent and Intents.BatchUpdateIntents methods. Format: projects//agent/ intents/.

  • 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 used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
# File 'lib/google/apis/dialogflow_v2/service.rb', line 1919

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_knowledge_basis(name, google_cloud_dialogflow_v2_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase

Updates the specified knowledge base.

Parameters:

  • name (String)

    The knowledge base resource name. The name must be empty when creating a knowledge base. Format: projects//locations//knowledgeBases/.

  • google_cloud_dialogflow_v2_knowledge_base_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def patch_project_agent_knowledge_basis(name, google_cloud_dialogflow_v2_knowledge_base_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::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
  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_knowledge_basis_document(name, google_cloud_dialogflow_v2_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Updates the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Parameters:

  • name (String)

    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.

  • google_cloud_dialogflow_v2_document_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2306

def patch_project_agent_knowledge_basis_document(name, google_cloud_dialogflow_v2_document_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::GoogleCloudDialogflowV2Document::Representation
  command.request_object = google_cloud_dialogflow_v2_document_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_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//agent/ sessions//contexts/, or projects//agent/environments//users//sessions// contexts/. 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. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2620

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/ /agent/sessions//entityTypes/, or projects//agent/environments//users// sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default ' -' user. `` 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2814

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. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/

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

    Required. The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2988

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

#patch_project_answer_record(name, google_cloud_dialogflow_v2_answer_record_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord

Updates the specified answer record.

Parameters:

  • name (String)

    The unique identifier of this answer record. Format: projects//locations// answerRecords/.

  • google_cloud_dialogflow_v2_answer_record_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3071

def patch_project_answer_record(name, google_cloud_dialogflow_v2_answer_record_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::GoogleCloudDialogflowV2AnswerRecord::Representation
  command.request_object = google_cloud_dialogflow_v2_answer_record_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord
  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_conversation_participant(name, google_cloud_dialogflow_v2_participant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant

Updates the specified participant.

Parameters:

  • name (String)

    Optional. The unique identifier of this participant. Format: projects// locations//conversations//participants/.

  • google_cloud_dialogflow_v2_participant_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to specify which fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4124

def patch_project_conversation_participant(name, google_cloud_dialogflow_v2_participant_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::GoogleCloudDialogflowV2Participant::Representation
  command.request_object = google_cloud_dialogflow_v2_participant_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant
  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_conversation_profile(name, google_cloud_dialogflow_v2_conversation_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile

Updates the specified conversation profile. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.

Parameters:

  • name (String)

    The unique identifier of this conversation profile. Format: projects// locations//conversationProfiles/.

  • google_cloud_dialogflow_v2_conversation_profile_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def patch_project_conversation_profile(name, google_cloud_dialogflow_v2_conversation_profile_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::GoogleCloudDialogflowV2ConversationProfile::Representation
  command.request_object = google_cloud_dialogflow_v2_conversation_profile_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile
  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_knowledge_basis(name, google_cloud_dialogflow_v2_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase

Updates the specified knowledge base.

Parameters:

  • name (String)

    The knowledge base resource name. The name must be empty when creating a knowledge base. Format: projects//locations//knowledgeBases/.

  • google_cloud_dialogflow_v2_knowledge_base_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4569

def patch_project_knowledge_basis(name, google_cloud_dialogflow_v2_knowledge_base_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::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
  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_knowledge_basis_document(name, google_cloud_dialogflow_v2_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Updates the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Parameters:

  • name (String)

    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.

  • google_cloud_dialogflow_v2_document_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4840

def patch_project_knowledge_basis_document(name, google_cloud_dialogflow_v2_document_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::GoogleCloudDialogflowV2Document::Representation
  command.request_object = google_cloud_dialogflow_v2_document_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    The unique identifier of the entity type. Required for EntityTypes. UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.

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

    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5660

def patch_project_location_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_location_agent_environment(name, google_cloud_dialogflow_v2_environment_object = nil, allow_load_to_draft_and_discard_changes: 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 an 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 continues serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

Parameters:

  • name (String)

    Output only. The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/ environments/ The environment ID for the default environment is -.

  • google_cloud_dialogflow_v2_environment_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Environment) (defaults to: nil)
  • allow_load_to_draft_and_discard_changes (Boolean) (defaults to: nil)

    Optional. This field is used to prevent accidental overwrite of the default environment, which is an operation that cannot be undone. To confirm that the caller desires this overwrite, this field must be explicitly set to true when updating the default environment (environment ID = -).

  • update_mask (String) (defaults to: nil)

    Required. The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6018

def patch_project_location_agent_environment(name, google_cloud_dialogflow_v2_environment_object = nil, allow_load_to_draft_and_discard_changes: 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['allowLoadToDraftAndDiscardChanges'] = allow_load_to_draft_and_discard_changes unless allow_load_to_draft_and_discard_changes.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_agent_environment_user_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//agent/ sessions//contexts/, or projects//agent/environments//users//sessions// contexts/. 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. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6341

def patch_project_location_agent_environment_user_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_location_agent_environment_user_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/ /agent/sessions//entityTypes/, or projects//agent/environments//users// sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default ' -' user. `` 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6535

def patch_project_location_agent_environment_user_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_location_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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • name (String)

    Optional. The unique identifier of this intent. Required for Intents. UpdateIntent and Intents.BatchUpdateIntents methods. Format: projects//agent/ intents/.

  • 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 used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
# File 'lib/google/apis/dialogflow_v2/service.rb', line 6832

def patch_project_location_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_location_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//agent/ sessions//contexts/, or projects//agent/environments//users//sessions// contexts/. 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. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7106

def patch_project_location_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_location_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/ /agent/sessions//entityTypes/, or projects//agent/environments//users// sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default ' -' user. `` 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7300

def patch_project_location_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_location_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. Supported formats: - projects//agent/versions/ - projects//locations//agent/versions/

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

    Required. The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7474

def patch_project_location_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

#patch_project_location_answer_record(name, google_cloud_dialogflow_v2_answer_record_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord

Updates the specified answer record.

Parameters:

  • name (String)

    The unique identifier of this answer record. Format: projects//locations// answerRecords/.

  • google_cloud_dialogflow_v2_answer_record_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to control which fields get updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7557

def patch_project_location_answer_record(name, google_cloud_dialogflow_v2_answer_record_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::GoogleCloudDialogflowV2AnswerRecord::Representation
  command.request_object = google_cloud_dialogflow_v2_answer_record_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AnswerRecord
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_conversation_participant(name, google_cloud_dialogflow_v2_participant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant

Updates the specified participant.

Parameters:

  • name (String)

    Optional. The unique identifier of this participant. Format: projects// locations//conversations//participants/.

  • google_cloud_dialogflow_v2_participant_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to specify which fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8718

def patch_project_location_conversation_participant(name, google_cloud_dialogflow_v2_participant_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::GoogleCloudDialogflowV2Participant::Representation
  command.request_object = google_cloud_dialogflow_v2_participant_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_conversation_profile(name, google_cloud_dialogflow_v2_conversation_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile

Updates the specified conversation profile. ConversationProfile.CreateTime and ConversationProfile.UpdateTime aren't populated in the response. You can retrieve them via GetConversationProfile API.

Parameters:

  • name (String)

    The unique identifier of this conversation profile. Format: projects// locations//conversationProfiles/.

  • google_cloud_dialogflow_v2_conversation_profile_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The mask to control which fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8281

def patch_project_location_conversation_profile(name, google_cloud_dialogflow_v2_conversation_profile_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::GoogleCloudDialogflowV2ConversationProfile::Representation
  command.request_object = google_cloud_dialogflow_v2_conversation_profile_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_generator(name, google_cloud_dialogflow_v2_generator_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator

Updates a generator.

Parameters:

  • name (String)

    Output only. Identifier. The resource name of the generator. Format: projects/ /locations//generators/

  • google_cloud_dialogflow_v2_generator_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. The list of fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9071

def patch_project_location_generator(name, google_cloud_dialogflow_v2_generator_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::GoogleCloudDialogflowV2Generator::Representation
  command.request_object = google_cloud_dialogflow_v2_generator_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_knowledge_basis(name, google_cloud_dialogflow_v2_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase

Updates the specified knowledge base.

Parameters:

  • name (String)

    The knowledge base resource name. The name must be empty when creating a knowledge base. Format: projects//locations//knowledgeBases/.

  • google_cloud_dialogflow_v2_knowledge_base_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9262

def patch_project_location_knowledge_basis(name, google_cloud_dialogflow_v2_knowledge_base_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::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Updates the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Parameters:

  • name (String)

    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.

  • google_cloud_dialogflow_v2_document_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Document) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Not specified means update all. Currently, only display_name can be updated, an InvalidArgument will be returned for attempting to update other fields.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9533

def patch_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2_document_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::GoogleCloudDialogflowV2Document::Representation
  command.request_object = google_cloud_dialogflow_v2_document_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reload_project_agent_knowledge_basis_document(name, google_cloud_dialogflow_v2_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. This method is a long- running operation. The returned Operation type has the following method- specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Parameters:

  • name (String)

    Required. The name of the document to reload. Format: projects//locations// knowledgeBases//documents/

  • google_cloud_dialogflow_v2_reload_document_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ReloadDocumentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
# File 'lib/google/apis/dialogflow_v2/service.rb', line 2349

def reload_project_agent_knowledge_basis_document(name, google_cloud_dialogflow_v2_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:reload', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ReloadDocumentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_reload_document_request_object
  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

#reload_project_knowledge_basis_document(name, google_cloud_dialogflow_v2_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. This method is a long- running operation. The returned Operation type has the following method- specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Parameters:

  • name (String)

    Required. The name of the document to reload. Format: projects//locations// knowledgeBases//documents/

  • google_cloud_dialogflow_v2_reload_document_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ReloadDocumentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4883

def reload_project_knowledge_basis_document(name, google_cloud_dialogflow_v2_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:reload', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ReloadDocumentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_reload_document_request_object
  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

#reload_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. This method is a long- running operation. The returned Operation type has the following method- specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Parameters:

  • name (String)

    Required. The name of the document to reload. Format: projects//locations// knowledgeBases//documents/

  • google_cloud_dialogflow_v2_reload_document_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ReloadDocumentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9576

def reload_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:reload', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ReloadDocumentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_reload_document_request_object
  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

#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. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: An empty Struct message - response : An Empty message The operation only tracks when restoring is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



346
347
348
349
350
351
352
353
354
355
356
# File 'lib/google/apis/dialogflow_v2/service.rb', line 346

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

#restore_project_location_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. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. This method is a long-running operation. The returned Operation type has the following method- specific fields: - metadata: An empty Struct message - response : An Empty message The operation only tracks when restoring is complete, not when it is done training. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5259

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

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



387
388
389
390
391
392
393
394
395
396
397
# File 'lib/google/apis/dialogflow_v2/service.rb', line 387

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

#search_project_conversation_suggestion_knowledge(conversation, google_cloud_dialogflow_v2_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse

Get answers for the given query based on knowledge documents.

Parameters:

  • conversation (String)

    The conversation (between human agent and end user) where the search request is triggered. Format: projects//locations//conversations/.

  • google_cloud_dialogflow_v2_search_knowledge_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4263

def search_project_conversation_suggestion_knowledge(conversation, google_cloud_dialogflow_v2_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+conversation}/suggestions:searchKnowledge', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_search_knowledge_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse
  command.params['conversation'] = conversation unless conversation.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_location_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/.

  • 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:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5300

def search_project_location_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

#search_project_location_conversation_suggestion_knowledge(conversation, google_cloud_dialogflow_v2_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse

Get answers for the given query based on knowledge documents.

Parameters:

  • conversation (String)

    The conversation (between human agent and end user) where the search request is triggered. Format: projects//locations//conversations/.

  • google_cloud_dialogflow_v2_search_knowledge_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8857

def search_project_location_conversation_suggestion_knowledge(conversation, google_cloud_dialogflow_v2_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+conversation}/suggestions:searchKnowledge', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_search_knowledge_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse
  command.params['conversation'] = conversation unless conversation.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_location_suggestion_knowledge(parent, google_cloud_dialogflow_v2_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse

Get answers for the given query based on knowledge documents.

Parameters:

  • parent (String)

    The parent resource contains the conversation profile Format: 'projects/' or projects//locations/.

  • google_cloud_dialogflow_v2_search_knowledge_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9788

def search_project_location_suggestion_knowledge(parent, google_cloud_dialogflow_v2_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/suggestions:searchKnowledge', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_search_knowledge_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse
  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_suggestion_knowledge(parent, google_cloud_dialogflow_v2_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse

Get answers for the given query based on knowledge documents.

Parameters:

  • parent (String)

    The parent resource contains the conversation profile Format: 'projects/' or projects//locations/.

  • google_cloud_dialogflow_v2_search_knowledge_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
# File 'lib/google/apis/dialogflow_v2/service.rb', line 9965

def search_project_suggestion_knowledge(parent, google_cloud_dialogflow_v2_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/suggestions:searchKnowledge', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_search_knowledge_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeResponse
  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

#set_project_agent(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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The project of this agent. Format: projects/.

  • 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:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/google/apis/dialogflow_v2/service.rb', line 142

def set_project_agent(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

#set_project_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2_set_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: SetSuggestionFeatureConfigOperationMetadata - response: ConversationProfile If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

Parameters:

  • conversation_profile (String)

    Required. The Conversation Profile to add or update the suggestion feature config. Format: projects//locations//conversationProfiles/.

  • google_cloud_dialogflow_v2_set_suggestion_feature_config_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SetSuggestionFeatureConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3732

def set_project_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2_set_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+conversationProfile}:setSuggestionFeatureConfig', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SetSuggestionFeatureConfigRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_set_suggestion_feature_config_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
  command.params['conversationProfile'] = conversation_profile unless conversation_profile.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_agent(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. Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The project of this agent. Format: projects/.

  • 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:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5055

def set_project_location_agent(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

#set_project_location_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2_set_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: SetSuggestionFeatureConfigOperationMetadata - response: ConversationProfile If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

Parameters:

  • conversation_profile (String)

    Required. The Conversation Profile to add or update the suggestion feature config. Format: projects//locations//conversationProfiles/.

  • google_cloud_dialogflow_v2_set_suggestion_feature_config_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SetSuggestionFeatureConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8326

def set_project_location_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2_set_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+conversationProfile}:setSuggestionFeatureConfig', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SetSuggestionFeatureConfigRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_set_suggestion_feature_config_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleLongrunningOperation
  command.params['conversationProfile'] = conversation_profile unless conversation_profile.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#suggest_project_conversation_participant_suggestion_articles(parent, google_cloud_dialogflow_v2_suggest_articles_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse

Gets suggested articles for a participant based on specific historical messages.

Parameters:

  • parent (String)

    Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.

  • google_cloud_dialogflow_v2_suggest_articles_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4160

def suggest_project_conversation_participant_suggestion_articles(parent, google_cloud_dialogflow_v2_suggest_articles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestArticles', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_suggest_articles_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse
  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

#suggest_project_conversation_participant_suggestion_faq_answers(parent, google_cloud_dialogflow_v2_suggest_faq_answers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse

Gets suggested faq answers for a participant based on specific historical messages.

Parameters:

  • parent (String)

    Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.

  • google_cloud_dialogflow_v2_suggest_faq_answers_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4195

def suggest_project_conversation_participant_suggestion_faq_answers(parent, google_cloud_dialogflow_v2_suggest_faq_answers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestFaqAnswers', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_suggest_faq_answers_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse
  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

#suggest_project_conversation_participant_suggestion_smart_replies(parent, google_cloud_dialogflow_v2_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse

Gets smart replies for a participant based on specific historical messages.

Parameters:

  • parent (String)

    Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.

  • google_cloud_dialogflow_v2_suggest_smart_replies_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4229

def suggest_project_conversation_participant_suggestion_smart_replies(parent, google_cloud_dialogflow_v2_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestSmartReplies', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_suggest_smart_replies_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse
  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

#suggest_project_conversation_suggestion_conversation_summary(conversation, google_cloud_dialogflow_v2_suggest_conversation_summary_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestConversationSummaryResponse

Suggests summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.

Parameters:

  • conversation (String)

    Required. The conversation to fetch suggestion for. Format: projects// locations//conversations/.

  • google_cloud_dialogflow_v2_suggest_conversation_summary_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestConversationSummaryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
# File 'lib/google/apis/dialogflow_v2/service.rb', line 4298

def suggest_project_conversation_suggestion_conversation_summary(conversation, google_cloud_dialogflow_v2_suggest_conversation_summary_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+conversation}/suggestions:suggestConversationSummary', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestConversationSummaryRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_suggest_conversation_summary_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestConversationSummaryResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestConversationSummaryResponse
  command.params['conversation'] = conversation unless conversation.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#suggest_project_location_conversation_participant_suggestion_articles(parent, google_cloud_dialogflow_v2_suggest_articles_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse

Gets suggested articles for a participant based on specific historical messages.

Parameters:

  • parent (String)

    Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.

  • google_cloud_dialogflow_v2_suggest_articles_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8754

def suggest_project_location_conversation_participant_suggestion_articles(parent, google_cloud_dialogflow_v2_suggest_articles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestArticles', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_suggest_articles_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestArticlesResponse
  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

#suggest_project_location_conversation_participant_suggestion_faq_answers(parent, google_cloud_dialogflow_v2_suggest_faq_answers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse

Gets suggested faq answers for a participant based on specific historical messages.

Parameters:

  • parent (String)

    Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.

  • google_cloud_dialogflow_v2_suggest_faq_answers_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8789

def suggest_project_location_conversation_participant_suggestion_faq_answers(parent, google_cloud_dialogflow_v2_suggest_faq_answers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestFaqAnswers', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_suggest_faq_answers_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestFaqAnswersResponse
  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

#suggest_project_location_conversation_participant_suggestion_smart_replies(parent, google_cloud_dialogflow_v2_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse

Gets smart replies for a participant based on specific historical messages.

Parameters:

  • parent (String)

    Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.

  • google_cloud_dialogflow_v2_suggest_smart_replies_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8823

def suggest_project_location_conversation_participant_suggestion_smart_replies(parent, google_cloud_dialogflow_v2_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/suggestions:suggestSmartReplies', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_suggest_smart_replies_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestSmartRepliesResponse
  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

#suggest_project_location_conversation_suggestion_conversation_summary(conversation, google_cloud_dialogflow_v2_suggest_conversation_summary_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestConversationSummaryResponse

Suggests summary for a conversation based on specific historical messages. The range of the messages to be used for summary can be specified in the request.

Parameters:

  • conversation (String)

    Required. The conversation to fetch suggestion for. Format: projects// locations//conversations/.

  • google_cloud_dialogflow_v2_suggest_conversation_summary_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestConversationSummaryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
# File 'lib/google/apis/dialogflow_v2/service.rb', line 8892

def suggest_project_location_conversation_suggestion_conversation_summary(conversation, google_cloud_dialogflow_v2_suggest_conversation_summary_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+conversation}/suggestions:suggestConversationSummary', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestConversationSummaryRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_suggest_conversation_summary_request_object
  command.response_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestConversationSummaryResponse::Representation
  command.response_class = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SuggestConversationSummaryResponse
  command.params['conversation'] = conversation unless conversation.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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The project that the agent to train is associated with. Format: projects/.

  • 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:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



428
429
430
431
432
433
434
435
436
437
438
# File 'lib/google/apis/dialogflow_v2/service.rb', line 428

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

#train_project_location_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. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

  • parent (String)

    Required. The project that the agent to train is associated with. Format: projects/.

  • 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:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5341

def train_project_location_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

#undeploy_project_conversation_model(name, google_cloud_dialogflow_v2_undeploy_conversation_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Undeploys a model. If the model is not deployed this method has no effect. If the model is currently being used: - For article suggestion, article suggestion will fallback to the default model if model is undeployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: UndeployConversationModelOperationMetadata - response: An Empty message

Parameters:

  • name (String)

    Required. The conversation model to undeploy. Format: projects// conversationModels/

  • google_cloud_dialogflow_v2_undeploy_conversation_model_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2UndeployConversationModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'lib/google/apis/dialogflow_v2/service.rb', line 3405

def undeploy_project_conversation_model(name, google_cloud_dialogflow_v2_undeploy_conversation_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:undeploy', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2UndeployConversationModelRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_undeploy_conversation_model_request_object
  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

#undeploy_project_location_conversation_model(name, google_cloud_dialogflow_v2_undeploy_conversation_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2::GoogleLongrunningOperation

Undeploys a model. If the model is not deployed this method has no effect. If the model is currently being used: - For article suggestion, article suggestion will fallback to the default model if model is undeployed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: UndeployConversationModelOperationMetadata - response: An Empty message

Parameters:

  • name (String)

    Required. The conversation model to undeploy. Format: projects// conversationModels/

  • google_cloud_dialogflow_v2_undeploy_conversation_model_request_object (Google::Apis::DialogflowV2::GoogleCloudDialogflowV2UndeployConversationModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
# File 'lib/google/apis/dialogflow_v2/service.rb', line 7965

def undeploy_project_location_conversation_model(name, google_cloud_dialogflow_v2_undeploy_conversation_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:undeploy', options)
  command.request_representation = Google::Apis::DialogflowV2::GoogleCloudDialogflowV2UndeployConversationModelRequest::Representation
  command.request_object = google_cloud_dialogflow_v2_undeploy_conversation_model_request_object
  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

#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. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.

  • 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:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



466
467
468
469
470
471
472
473
474
475
476
477
# File 'lib/google/apis/dialogflow_v2/service.rb', line 466

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

#update_project_location_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. Supported formats: - projects//agent/fulfillment - projects//locations//agent/fulfillment This field is not used for Fulfillment in an Environment.

  • 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:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
# File 'lib/google/apis/dialogflow_v2/service.rb', line 5379

def update_project_location_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