Class: Google::Apis::DialogflowV2beta1::DialogflowService

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

Overview

Dialogflow API

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

Examples:

require 'google/apis/dialogflow_v2beta1'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DialogflowService

Returns a new instance of DialogflowService.



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

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

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



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

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



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

def quota_user
  @quota_user
end

Instance Method Details

#analyze_project_conversation_participant_content(participant, google_cloud_dialogflow_v2beta1_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentResponse

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_v2beta1_analyze_content_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentRequest) (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



3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3736

def analyze_project_conversation_participant_content(participant, google_cloud_dialogflow_v2beta1_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+participant}:analyzeContent', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_analyze_content_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentResponse
  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_v2beta1_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentResponse

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_v2beta1_analyze_content_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentRequest) (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



7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7952

def analyze_project_location_conversation_participant_content(participant, google_cloud_dialogflow_v2beta1_analyze_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+participant}:analyzeContent', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_analyze_content_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnalyzeContentResponse
  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_delete_entity_types(parent, google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats: - projects//agent, - projects//locations//agent.

  • google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest) (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



511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 511

def batch_delete_entity_types(parent, google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_delete_intents(parent, google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats: - projects//agent - projects//locations//agent

  • google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest) (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



1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1699

def batch_delete_intents(parent, google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/intents:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_entity_create_entities(parent, google_cloud_dialogflow_v2beta1_batch_create_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats:

    • projects//agent/entityTypes/ - projects//locations//agent/entityTypes/
  • google_cloud_dialogflow_v2beta1_batch_create_entities_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest) (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



797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 797

def batch_entity_create_entities(parent, google_cloud_dialogflow_v2beta1_batch_create_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entities:batchCreate', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_create_entities_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_entity_delete_entities(parent, google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats:

    • projects//agent/entityTypes/ - projects//locations//agent/entityTypes/
  • google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest) (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



839
840
841
842
843
844
845
846
847
848
849
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 839

def batch_entity_delete_entities(parent, google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entities:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_entity_update_entities(parent, google_cloud_dialogflow_v2beta1_batch_update_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Note: You should always train an agent prior to sending it queries. See the training documentation. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message

Parameters:

  • parent (String) —

    Required. The name of the entity type to update or create entities in. Supported formats: - projects//agent/entityTypes/ - projects//locations// agent/entityTypes/

  • google_cloud_dialogflow_v2beta1_batch_update_entities_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest) (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



883
884
885
886
887
888
889
890
891
892
893
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 883

def batch_entity_update_entities(parent, google_cloud_dialogflow_v2beta1_batch_update_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entities:batchUpdate', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_update_entities_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_conversation_message_create(parent, google_cloud_dialogflow_v2beta1_batch_create_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateMessagesResponse

Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.

Parameters:

  • parent (String) —

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

  • google_cloud_dialogflow_v2beta1_batch_create_messages_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateMessagesRequest) (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



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

def batch_project_conversation_message_create(parent, google_cloud_dialogflow_v2beta1_batch_create_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/messages:batchCreate', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateMessagesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_create_messages_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateMessagesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateMessagesResponse
  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_v2beta1_batch_delete_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats: - projects//agent, - projects//locations//agent.

  • google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest) (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



5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5177

def batch_project_location_agent_entity_type_delete(parent, google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_batch_create_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats:

    • projects//agent/entityTypes/ - projects//locations//agent/entityTypes/
  • google_cloud_dialogflow_v2beta1_batch_create_entities_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest) (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_v2beta1/service.rb', line 5463

def batch_project_location_agent_entity_type_entity_create(parent, google_cloud_dialogflow_v2beta1_batch_create_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entities:batchCreate', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_create_entities_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_batch_delete_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats:

    • projects//agent/entityTypes/ - projects//locations//agent/entityTypes/
  • google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest) (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



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

def batch_project_location_agent_entity_type_entity_delete(parent, google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entities:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_batch_update_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Note: You should always train an agent prior to sending it queries. See the training documentation. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: An Empty message

Parameters:

  • parent (String) —

    Required. The name of the entity type to update or create entities in. Supported formats: - projects//agent/entityTypes/ - projects//locations// agent/entityTypes/

  • google_cloud_dialogflow_v2beta1_batch_update_entities_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest) (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



5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5549

def batch_project_location_agent_entity_type_entity_update(parent, google_cloud_dialogflow_v2beta1_batch_update_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entities:batchUpdate', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_update_entities_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_batch_update_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats: - projects//agent - projects//locations//agent

  • google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest) (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



5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5218

def batch_project_location_agent_entity_type_update(parent, google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes:batchUpdate', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_batch_delete_intents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats: - projects//agent - projects//locations//agent

  • google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest) (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



6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6365

def batch_project_location_agent_intent_delete(parent, google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/intents:batchDelete', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_batch_update_intents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats: - projects//agent - projects//locations//agent

  • google_cloud_dialogflow_v2beta1_batch_update_intents_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest) (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



6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6406

def batch_project_location_agent_intent_update(parent, google_cloud_dialogflow_v2beta1_batch_update_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/intents:batchUpdate', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_update_intents_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_conversation_message_create(parent, google_cloud_dialogflow_v2beta1_batch_create_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateMessagesResponse

Batch ingests messages to conversation. Customers can use this RPC to ingest historical messages to conversation.

Parameters:

  • parent (String) —

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

  • google_cloud_dialogflow_v2beta1_batch_create_messages_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateMessagesRequest) (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



7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7867

def batch_project_location_conversation_message_create(parent, google_cloud_dialogflow_v2beta1_batch_create_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/messages:batchCreate', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateMessagesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_create_messages_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateMessagesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateMessagesResponse
  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_update_entity_types(parent, google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats: - projects//agent - projects//locations//agent

  • google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest) (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



552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 552

def batch_update_entity_types(parent, google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes:batchUpdate', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_update_intents(parent, google_cloud_dialogflow_v2beta1_batch_update_intents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Supported formats: - projects//agent - projects//locations//agent

  • google_cloud_dialogflow_v2beta1_batch_update_intents_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest) (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



1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1740

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



8795
8796
8797
8798
8799
8800
8801
8802
8803
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8795

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



8972
8973
8974
8975
8976
8977
8978
8979
8980
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8972

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



3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3229

def clear_project_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2beta1_clear_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+conversationProfile}:clearSuggestionFeatureConfig', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_clear_suggestion_feature_config_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_clear_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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_v2beta1_clear_suggestion_feature_config_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigRequest) (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



7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7445

def clear_project_location_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2beta1_clear_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+conversationProfile}:clearSuggestionFeatureConfig', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ClearSuggestionFeatureConfigRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_clear_suggestion_feature_config_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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

#compile_project_conversation_participant_suggestion(parent, google_cloud_dialogflow_v2beta1_compile_suggestion_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionResponse

Deprecated. use SuggestArticles and SuggestFaqAnswers instead. Gets suggestions for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Parameters:

  • parent (String) —

    Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.

  • google_cloud_dialogflow_v2beta1_compile_suggestion_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionRequest) (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



3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3914

def compile_project_conversation_participant_suggestion(parent, google_cloud_dialogflow_v2beta1_compile_suggestion_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:compile', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_compile_suggestion_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompileSuggestionResponse
  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

#complete_project_conversation(name, google_cloud_dialogflow_v2beta1_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation

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_v2beta1_complete_conversation_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompleteConversationRequest) (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



3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3483

def complete_project_conversation(name, google_cloud_dialogflow_v2beta1_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+name}:complete', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompleteConversationRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_complete_conversation_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation
  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_v2beta1_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation

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_v2beta1_complete_conversation_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompleteConversationRequest) (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



7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7699

def complete_project_location_conversation(name, google_cloud_dialogflow_v2beta1_complete_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+name}:complete', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CompleteConversationRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_complete_conversation_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation
  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_v2beta1_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType

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

  • google_cloud_dialogflow_v2beta1_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType) (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



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

def create_project_agent_entity_type(parent, google_cloud_dialogflow_v2beta1_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType
  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_v2beta1_environment_object = nil, environment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment

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_v2beta1_environment_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment) (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



919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 919

def create_project_agent_environment(parent, google_cloud_dialogflow_v2beta1_environment_object = nil, environment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/environments', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_environment_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment
  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_v2beta1_context_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

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

Parameters:

  • parent (String) —

    Required. The session to create a context for. Supported formats: - projects// agent/sessions/, -projects//locations//agent/sessions/, -projects//agent/ environments//users//sessions/, -projects//locations//agent/environments// users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser ID` is not specified, we assume default '-' user.

  • google_cloud_dialogflow_v2beta1_context_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context) (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



1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1291

def create_project_agent_environment_user_session_context(parent, google_cloud_dialogflow_v2beta1_context_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/contexts', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_context_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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_v2beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser ID` is not specified, we assume default '-' user.

  • google_cloud_dialogflow_v2beta1_session_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType) (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



1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1491

def create_project_agent_environment_user_session_entity_type(parent, google_cloud_dialogflow_v2beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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_v2beta1_intent_object = nil, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent

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

  • google_cloud_dialogflow_v2beta1_intent_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent) (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



1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1783

def create_project_agent_intent(parent, google_cloud_dialogflow_v2beta1_intent_object = nil, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/intents', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_intent_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent
  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_v2beta1_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase

Creates a knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

Parameters:

  • parent (String) —

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

  • google_cloud_dialogflow_v2beta1_knowledge_base_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase) (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



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

def create_project_agent_knowledge_basis(parent, google_cloud_dialogflow_v2beta1_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/knowledgeBases', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
  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_v2beta1_document_object = nil, import_gcs_custom_metadata: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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 Note: The projects.agent. knowledgeBases.documents resource is deprecated; only use projects. knowledgeBases.documents.

Parameters:

  • parent (String) —

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

  • google_cloud_dialogflow_v2beta1_document_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document) (defaults to: nil)
  • import_gcs_custom_metadata (Boolean) (defaults to: nil) —

    Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def create_project_agent_knowledge_basis_document(parent, google_cloud_dialogflow_v2beta1_document_object = nil, import_gcs_custom_metadata: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/documents', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_document_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['importGcsCustomMetadata'] = import_gcs_custom_metadata unless import_gcs_custom_metadata.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_v2beta1_context_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

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

Parameters:

  • parent (String) —

    Required. The session to create a context for. Supported formats: - projects// agent/sessions/, -projects//locations//agent/sessions/, -projects//agent/ environments//users//sessions/, -projects//locations//agent/environments// users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser ID` is not specified, we assume default '-' user.

  • google_cloud_dialogflow_v2beta1_context_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context) (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



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

def create_project_agent_session_context(parent, google_cloud_dialogflow_v2beta1_context_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/contexts', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_context_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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_v2beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser ID` is not specified, we assume default '-' user.

  • google_cloud_dialogflow_v2beta1_session_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType) (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



2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2737

def create_project_agent_session_entity_type(parent, google_cloud_dialogflow_v2beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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_v2beta1_version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version

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_v2beta1_version_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version) (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



2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2938

def create_project_agent_version(parent, google_cloud_dialogflow_v2beta1_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/versions', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_version_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version
  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_v2beta1_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation

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_v2beta1_conversation_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation) (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



3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3534

def create_project_conversation(parent, google_cloud_dialogflow_v2beta1_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/conversations', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_conversation_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation
  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_participant(parent, google_cloud_dialogflow_v2beta1_participant_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant

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_v2beta1_participant_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant) (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



3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3770

def create_project_conversation_participant(parent, google_cloud_dialogflow_v2beta1_participant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/participants', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_participant_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant
  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_v2beta1_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile

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_v2beta1_conversation_profile_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile) (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



3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3265

def create_project_conversation_profile(parent, google_cloud_dialogflow_v2beta1_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/conversationProfiles', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_conversation_profile_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile
  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(parent, google_cloud_dialogflow_v2beta1_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase

Creates a knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

Parameters:

  • parent (String) —

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

  • google_cloud_dialogflow_v2beta1_knowledge_base_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase) (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



4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4180

def create_project_knowledge_basis(parent, google_cloud_dialogflow_v2beta1_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/knowledgeBases', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
  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_v2beta1_document_object = nil, import_gcs_custom_metadata: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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 Note: The projects.agent. knowledgeBases.documents resource is deprecated; only use projects. knowledgeBases.documents.

Parameters:

  • parent (String) —

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

  • google_cloud_dialogflow_v2beta1_document_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document) (defaults to: nil)
  • import_gcs_custom_metadata (Boolean) (defaults to: nil) —

    Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4384

def create_project_knowledge_basis_document(parent, google_cloud_dialogflow_v2beta1_document_object = nil, import_gcs_custom_metadata: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/documents', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_document_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['importGcsCustomMetadata'] = import_gcs_custom_metadata unless import_gcs_custom_metadata.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_v2beta1_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType

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

  • google_cloud_dialogflow_v2beta1_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType) (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



5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5259

def create_project_location_agent_entity_type(parent, google_cloud_dialogflow_v2beta1_entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType
  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_v2beta1_environment_object = nil, environment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment

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_v2beta1_environment_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment) (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



5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5585

def create_project_location_agent_environment(parent, google_cloud_dialogflow_v2beta1_environment_object = nil, environment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/environments', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_environment_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment
  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_v2beta1_context_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

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

Parameters:

  • parent (String) —

    Required. The session to create a context for. Supported formats: - projects// agent/sessions/, -projects//locations//agent/sessions/, -projects//agent/ environments//users//sessions/, -projects//locations//agent/environments// users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser ID` is not specified, we assume default '-' user.

  • google_cloud_dialogflow_v2beta1_context_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context) (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



5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5957

def create_project_location_agent_environment_user_session_context(parent, google_cloud_dialogflow_v2beta1_context_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/contexts', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_context_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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_v2beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser ID` is not specified, we assume default '-' user.

  • google_cloud_dialogflow_v2beta1_session_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType) (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



6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6157

def create_project_location_agent_environment_user_session_entity_type(parent, google_cloud_dialogflow_v2beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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_v2beta1_intent_object = nil, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent

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

  • google_cloud_dialogflow_v2beta1_intent_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent) (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



6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6449

def create_project_location_agent_intent(parent, google_cloud_dialogflow_v2beta1_intent_object = nil, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/intents', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_intent_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent
  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_v2beta1_context_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

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

Parameters:

  • parent (String) —

    Required. The session to create a context for. Supported formats: - projects// agent/sessions/, -projects//locations//agent/sessions/, -projects//agent/ environments//users//sessions/, -projects//locations//agent/environments// users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser ID` is not specified, we assume default '-' user.

  • google_cloud_dialogflow_v2beta1_context_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context) (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



6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6753

def create_project_location_agent_session_context(parent, google_cloud_dialogflow_v2beta1_context_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/contexts', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_context_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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_v2beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser ID` is not specified, we assume default '-' user.

  • google_cloud_dialogflow_v2beta1_session_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType) (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



6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6953

def create_project_location_agent_session_entity_type(parent, google_cloud_dialogflow_v2beta1_session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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_v2beta1_version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version

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_v2beta1_version_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version) (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



7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7154

def create_project_location_agent_version(parent, google_cloud_dialogflow_v2beta1_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/versions', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_version_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version
  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_v2beta1_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation

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_v2beta1_conversation_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation) (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



7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7750

def create_project_location_conversation(parent, google_cloud_dialogflow_v2beta1_conversation_object = nil, conversation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/conversations', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_conversation_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation
  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_participant(parent, google_cloud_dialogflow_v2beta1_participant_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant

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_v2beta1_participant_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant) (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



7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7986

def create_project_location_conversation_participant(parent, google_cloud_dialogflow_v2beta1_participant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/participants', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_participant_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant
  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_v2beta1_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile

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_v2beta1_conversation_profile_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile) (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



7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7481

def create_project_location_conversation_profile(parent, google_cloud_dialogflow_v2beta1_conversation_profile_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/conversationProfiles', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_conversation_profile_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile
  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(parent, google_cloud_dialogflow_v2beta1_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase

Creates a knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

Parameters:

  • parent (String) —

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

  • google_cloud_dialogflow_v2beta1_knowledge_base_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase) (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



8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8302

def create_project_location_knowledge_basis(parent, google_cloud_dialogflow_v2beta1_knowledge_base_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/knowledgeBases', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
  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_v2beta1_document_object = nil, import_gcs_custom_metadata: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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 Note: The projects.agent. knowledgeBases.documents resource is deprecated; only use projects. knowledgeBases.documents.

Parameters:

  • parent (String) —

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

  • google_cloud_dialogflow_v2beta1_document_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document) (defaults to: nil)
  • import_gcs_custom_metadata (Boolean) (defaults to: nil) —

    Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8506

def create_project_location_knowledge_basis_document(parent, google_cloud_dialogflow_v2beta1_document_object = nil, import_gcs_custom_metadata: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/documents', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_document_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['importGcsCustomMetadata'] = import_gcs_custom_metadata unless import_gcs_custom_metadata.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::DialogflowV2beta1::GoogleProtobufEmpty

Deletes the specified agent.

Parameters:

  • parent (String) —

    Required. The project that the agent to delete is associated with. Format: projects/ or projects//locations/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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



629
630
631
632
633
634
635
636
637
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 629

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



953
954
955
956
957
958
959
960
961
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 953

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

Deletes the specified context.

Parameters:

  • name (String) —

    Required. The name of the context to delete. Supported formats: - projects// agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/,

    • projects//agent/environments//users//sessions//contexts/, - projects// locations//agent/environments//users//sessions//contexts/, If Location ID is not specified we assume default 'us' location. 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



1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1329

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

Deletes all active contexts in the specified session.

Parameters:

  • parent (String) —

    Required. The name of the session to delete all contexts from. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/ , -projects//agent/environments//users//sessions/, -projects//locations// agent/environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified we assume default 'draft' environment. IfUser 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



1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1200

def delete_project_agent_environment_user_session_contexts(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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. Supported formats: - projects//agent/sessions//entityTypes/ - projects//locations//agent/sessions/ /entityTypes/ - projects//agent/environments//users//sessions//entityTypes/

    • projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. 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



1531
1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1531

def delete_project_agent_environment_user_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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. Supported formats: - projects/ /agent/intents/ - projects//locations//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



1821
1822
1823
1824
1825
1826
1827
1828
1829
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1821

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

Deletes the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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



2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2030

def delete_project_agent_knowledge_basis(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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 Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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



2237
2238
2239
2240
2241
2242
2243
2244
2245
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2237

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

Deletes the specified context.

Parameters:

  • name (String) —

    Required. The name of the context to delete. Supported formats: - projects// agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/,

    • projects//agent/environments//users//sessions//contexts/, - projects// locations//agent/environments//users//sessions//contexts/, If Location ID is not specified we assume default 'us' location. 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



2575
2576
2577
2578
2579
2580
2581
2582
2583
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2575

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

Deletes all active contexts in the specified session.

Parameters:

  • parent (String) —

    Required. The name of the session to delete all contexts from. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/ , -projects//agent/environments//users//sessions/, -projects//locations// agent/environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified we assume default 'draft' environment. IfUser 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



2446
2447
2448
2449
2450
2451
2452
2453
2454
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2446

def delete_project_agent_session_contexts(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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. Supported formats: - projects//agent/sessions//entityTypes/ - projects//locations//agent/sessions/ /entityTypes/ - projects//agent/environments//users//sessions//entityTypes/

    • projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. 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



2777
2778
2779
2780
2781
2782
2783
2784
2785
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2777

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



2971
2972
2973
2974
2975
2976
2977
2978
2979
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2971

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



3298
3299
3300
3301
3302
3303
3304
3305
3306
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3298

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

Deletes the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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



4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4217

def delete_project_knowledge_basis(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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 Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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



4424
4425
4426
4427
4428
4429
4430
4431
4432
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4424

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

Deletes the specified agent.

Parameters:

  • parent (String) —

    Required. The project that the agent to delete is associated with. Format: projects/ or projects//locations/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4667
4668
4669
4670
4671
4672
4673
4674
4675
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4667

def delete_project_location_agent(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+parent}/agent', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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. Supported formats: - projects//agent/entityTypes/ - projects//locations//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



5295
5296
5297
5298
5299
5300
5301
5302
5303
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5295

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5619
5620
5621
5622
5623
5624
5625
5626
5627
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5619

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

Deletes the specified context.

Parameters:

  • name (String) —

    Required. The name of the context to delete. Supported formats: - projects// agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/,

    • projects//agent/environments//users//sessions//contexts/, - projects// locations//agent/environments//users//sessions//contexts/, If Location ID is not specified we assume default 'us' location. 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



5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5995

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

Deletes all active contexts in the specified session.

Parameters:

  • parent (String) —

    Required. The name of the session to delete all contexts from. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/ , -projects//agent/environments//users//sessions/, -projects//locations// agent/environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified we assume default 'draft' environment. IfUser 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



5866
5867
5868
5869
5870
5871
5872
5873
5874
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5866

def delete_project_location_agent_environment_user_session_contexts(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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. Supported formats: - projects//agent/sessions//entityTypes/ - projects//locations//agent/sessions/ /entityTypes/ - projects//agent/environments//users//sessions//entityTypes/

    • projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. 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



6197
6198
6199
6200
6201
6202
6203
6204
6205
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6197

def delete_project_location_agent_environment_user_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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. Supported formats: - projects/ /agent/intents/ - projects//locations//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



6487
6488
6489
6490
6491
6492
6493
6494
6495
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6487

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

Deletes the specified context.

Parameters:

  • name (String) —

    Required. The name of the context to delete. Supported formats: - projects// agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/,

    • projects//agent/environments//users//sessions//contexts/, - projects// locations//agent/environments//users//sessions//contexts/, If Location ID is not specified we assume default 'us' location. 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



6791
6792
6793
6794
6795
6796
6797
6798
6799
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6791

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

Deletes all active contexts in the specified session.

Parameters:

  • parent (String) —

    Required. The name of the session to delete all contexts from. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/ , -projects//agent/environments//users//sessions/, -projects//locations// agent/environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified we assume default 'draft' environment. IfUser 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



6662
6663
6664
6665
6666
6667
6668
6669
6670
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6662

def delete_project_location_agent_session_contexts(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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. Supported formats: - projects//agent/sessions//entityTypes/ - projects//locations//agent/sessions/ /entityTypes/ - projects//agent/environments//users//sessions//entityTypes/

    • projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. 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



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

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



7187
7188
7189
7190
7191
7192
7193
7194
7195
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7187

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



7514
7515
7516
7517
7518
7519
7520
7521
7522
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7514

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

Deletes the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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



8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8339

def delete_project_location_knowledge_basis(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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 Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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



8546
8547
8548
8549
8550
8551
8552
8553
8554
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8546

def delete_project_location_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse

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. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment (Environment IDmight be referred to as environment name at some places). IfUser IDis not specified, we are using "-". It's up to the API caller to choose an appropriateSession IDandUser Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of theSession IDandUser 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_v2beta1_detect_intent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest) (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



1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1252

def detect_project_agent_environment_user_session_intent(session, google_cloud_dialogflow_v2beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+session}:detectIntent', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse
  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_v2beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse

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. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment (Environment IDmight be referred to as environment name at some places). IfUser IDis not specified, we are using "-". It's up to the API caller to choose an appropriateSession IDandUser Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of theSession IDandUser 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_v2beta1_detect_intent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest) (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



5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5918

def detect_project_location_agent_environment_user_session_intent(session, google_cloud_dialogflow_v2beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+session}:detectIntent', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse
  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_v2beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse

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. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment (Environment IDmight be referred to as environment name at some places). IfUser IDis not specified, we are using "-". It's up to the API caller to choose an appropriateSession IDandUser Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of theSession IDandUser 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_v2beta1_detect_intent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest) (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



6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6714

def detect_project_location_agent_session_intent(session, google_cloud_dialogflow_v2beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+session}:detectIntent', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse
  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_session_intent(session, google_cloud_dialogflow_v2beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse

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. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment (Environment IDmight be referred to as environment name at some places). IfUser IDis not specified, we are using "-". It's up to the API caller to choose an appropriateSession IDandUser Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of theSession IDandUser 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_v2beta1_detect_intent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest) (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



2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2498

def detect_session_intent(session, google_cloud_dialogflow_v2beta1_detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+session}:detectIntent', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_detect_intent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentResponse
  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_agent(parent, google_cloud_dialogflow_v2beta1_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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/ or projects//locations/.

  • google_cloud_dialogflow_v2beta1_export_agent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ExportAgentRequest) (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



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

def export_agent(parent, google_cloud_dialogflow_v2beta1_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/agent:export', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ExportAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_export_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_agent(parent, google_cloud_dialogflow_v2beta1_export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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/ or projects//locations/.

  • google_cloud_dialogflow_v2beta1_export_agent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ExportAgentRequest) (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



4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4847

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

#generate_project_location_suggestion_stateless_summary(parent, google_cloud_dialogflow_v2beta1_generate_stateless_summary_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse

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_v2beta1_generate_stateless_summary_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequest) (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



8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8899

def generate_project_location_suggestion_stateless_summary(parent, google_cloud_dialogflow_v2beta1_generate_stateless_summary_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:generateStatelessSummary', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_generate_stateless_summary_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse
  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_v2beta1_generate_stateless_summary_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse

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_v2beta1_generate_stateless_summary_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequest) (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



9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 9076

def generate_project_suggestion_stateless_summary(parent, google_cloud_dialogflow_v2beta1_generate_stateless_summary_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:generateStatelessSummary', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GenerateStatelessSummaryRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_generate_stateless_summary_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GenerateStatelessSummaryResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent

Retrieves the specified agent.

Parameters:

  • parent (String) —

    Required. The project that the agent to fetch is associated with. Format: projects/ or projects//locations/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



105
106
107
108
109
110
111
112
113
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 105

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

Retrieves the specified entity type.

Parameters:

  • name (String) —

    Required. The name of the entity type. Supported formats: - projects//agent/ entityTypes/ - projects//locations//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



665
666
667
668
669
670
671
672
673
674
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 665

def get_project_agent_entity_type(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment

Retrieves the specified agent environment.

Parameters:

  • name (String) —

    Required. The name of the environment. Supported formats: - projects//agent/ environments/ - projects//locations//agent/environments/

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def get_project_agent_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EnvironmentHistory

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/

  • 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



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1021

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, 'v2beta1/{+parent}/history', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EnvironmentHistory::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EnvironmentHistory
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

Retrieves the specified context.

Parameters:

  • name (String) —

    Required. The name of the context. Supported formats: - projects//agent/ sessions//contexts/, - projects//locations//agent/sessions//contexts/, - projects//agent/environments//users//sessions//contexts/, - projects// locations//agent/environments//users//sessions//contexts/, If Location ID is not specified we assume default 'us' location. 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



1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1365

def get_project_agent_environment_user_session_context(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats: - projects// agent/sessions//entityTypes/ - projects//locations//agent/sessions// entityTypes/ - projects//agent/environments//users//sessions//entityTypes/ - projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. 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



1569
1570
1571
1572
1573
1574
1575
1576
1577
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1569

def get_project_agent_environment_user_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment

Retrieves the fulfillment.

Parameters:

  • name (String) —

    Required. The name of the fulfillment. Supported formats: - projects//agent/ fulfillment - projects//locations//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_v2beta1/service.rb', line 214

def get_project_agent_fulfillment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent

Retrieves the specified intent.

Parameters:

  • name (String) —

    Required. The name of the intent. Supported formats: - projects//agent/ intents/ - projects//locations//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



1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1859

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, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase

Retrieves the specified knowledge base. Note: The projects.agent. knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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



2063
2064
2065
2066
2067
2068
2069
2070
2071
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2063

def get_project_agent_knowledge_basis(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document

Retrieves the specified 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 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



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

def get_project_agent_knowledge_basis_document(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

Retrieves the specified context.

Parameters:

  • name (String) —

    Required. The name of the context. Supported formats: - projects//agent/ sessions//contexts/, - projects//locations//agent/sessions//contexts/, - projects//agent/environments//users//sessions//contexts/, - projects// locations//agent/environments//users//sessions//contexts/, If Location ID is not specified we assume default 'us' location. 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



2611
2612
2613
2614
2615
2616
2617
2618
2619
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2611

def get_project_agent_session_context(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats: - projects// agent/sessions//entityTypes/ - projects//locations//agent/sessions// entityTypes/ - projects//agent/environments//users//sessions//entityTypes/ - projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. 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



2815
2816
2817
2818
2819
2820
2821
2822
2823
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2815

def get_project_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ValidationResult

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/ or projects//locations/.

  • 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



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

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

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



3002
3003
3004
3005
3006
3007
3008
3009
3010
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3002

def get_project_agent_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version
  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_answer_record(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord

Deprecated. Retrieves a specific answer record.

Parameters:

  • name (String) —

    Required. The name of the answer record to retrieve. Format: projects// locations//answerRecords/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



3110
3111
3112
3113
3114
3115
3116
3117
3118
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3110

def get_project_answer_record(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation

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



3568
3569
3570
3571
3572
3573
3574
3575
3576
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3568

def get_project_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant

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



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

def get_project_conversation_participant(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile

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



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

def get_project_conversation_profile(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase

Retrieves the specified knowledge base. Note: The projects.agent. knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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



4250
4251
4252
4253
4254
4255
4256
4257
4258
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4250

def get_project_knowledge_basis(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document

Retrieves the specified 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 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



4457
4458
4459
4460
4461
4462
4463
4464
4465
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4457

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



4697
4698
4699
4700
4701
4702
4703
4704
4705
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4697

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

Retrieves the specified agent.

Parameters:

  • parent (String) —

    Required. The project that the agent to fetch is associated with. Format: projects/ or projects//locations/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



4728
4729
4730
4731
4732
4733
4734
4735
4736
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4728

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

Retrieves the specified entity type.

Parameters:

  • name (String) —

    Required. The name of the entity type. Supported formats: - projects//agent/ entityTypes/ - projects//locations//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



5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5331

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

Retrieves the specified agent environment.

Parameters:

  • name (String) —

    Required. The name of the environment. Supported formats: - projects//agent/ environments/ - projects//locations//agent/environments/

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



5650
5651
5652
5653
5654
5655
5656
5657
5658
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5650

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

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/

  • 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



5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5687

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, 'v2beta1/{+parent}/history', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EnvironmentHistory::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EnvironmentHistory
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

Retrieves the specified context.

Parameters:

  • name (String) —

    Required. The name of the context. Supported formats: - projects//agent/ sessions//contexts/, - projects//locations//agent/sessions//contexts/, - projects//agent/environments//users//sessions//contexts/, - projects// locations//agent/environments//users//sessions//contexts/, If Location ID is not specified we assume default 'us' location. 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



6031
6032
6033
6034
6035
6036
6037
6038
6039
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6031

def get_project_location_agent_environment_user_session_context(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats: - projects// agent/sessions//entityTypes/ - projects//locations//agent/sessions// entityTypes/ - projects//agent/environments//users//sessions//entityTypes/ - projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. 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



6235
6236
6237
6238
6239
6240
6241
6242
6243
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6235

def get_project_location_agent_environment_user_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment

Retrieves the fulfillment.

Parameters:

  • name (String) —

    Required. The name of the fulfillment. Supported formats: - projects//agent/ fulfillment - projects//locations//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



4880
4881
4882
4883
4884
4885
4886
4887
4888
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4880

def get_project_location_agent_fulfillment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent

Retrieves the specified intent.

Parameters:

  • name (String) —

    Required. The name of the intent. Supported formats: - projects//agent/ intents/ - projects//locations//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



6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6525

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, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

Retrieves the specified context.

Parameters:

  • name (String) —

    Required. The name of the context. Supported formats: - projects//agent/ sessions//contexts/, - projects//locations//agent/sessions//contexts/, - projects//agent/environments//users//sessions//contexts/, - projects// locations//agent/environments//users//sessions//contexts/, If Location ID is not specified we assume default 'us' location. 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



6827
6828
6829
6830
6831
6832
6833
6834
6835
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6827

def get_project_location_agent_session_context(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats: - projects// agent/sessions//entityTypes/ - projects//locations//agent/sessions// entityTypes/ - projects//agent/environments//users//sessions//entityTypes/ - projects//locations//agent/environments/ /users//sessions//entityTypes/ If Location ID is not specified we assume default 'us' location. 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



7031
7032
7033
7034
7035
7036
7037
7038
7039
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7031

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

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/ or projects//locations/.

  • 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



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

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

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



7218
7219
7220
7221
7222
7223
7224
7225
7226
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7218

def get_project_location_agent_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version
  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_answer_record(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord

Deprecated. Retrieves a specific answer record.

Parameters:

  • name (String) —

    Required. The name of the answer record to retrieve. Format: projects// locations//answerRecords/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

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

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



7326
7327
7328
7329
7330
7331
7332
7333
7334
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7326

def get_project_location_answer_record(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation

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



7784
7785
7786
7787
7788
7789
7790
7791
7792
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7784

def get_project_location_conversation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Conversation
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant

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



8019
8020
8021
8022
8023
8024
8025
8026
8027
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8019

def get_project_location_conversation_participant(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile

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



7545
7546
7547
7548
7549
7550
7551
7552
7553
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7545

def get_project_location_conversation_profile(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase

Retrieves the specified knowledge base. Note: The projects.agent. knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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



8372
8373
8374
8375
8376
8377
8378
8379
8380
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8372

def get_project_location_knowledge_basis(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document

Retrieves the specified 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 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



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

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



8826
8827
8828
8829
8830
8831
8832
8833
8834
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8826

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



9003
9004
9005
9006
9007
9008
9009
9010
9011
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 9003

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

  • google_cloud_dialogflow_v2beta1_import_agent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportAgentRequest) (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



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

def import_agent(parent, google_cloud_dialogflow_v2beta1_import_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/agent:import', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_import_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_knowledge_basis_document(parent, google_cloud_dialogflow_v2beta1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation

Create 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_v2beta1_import_documents_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportDocumentsRequest) (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



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

def import_project_knowledge_basis_document(parent, google_cloud_dialogflow_v2beta1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/documents:import', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportDocumentsRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_import_documents_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_import_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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/ or projects//locations/.

  • google_cloud_dialogflow_v2beta1_import_agent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportAgentRequest) (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



4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4965

def import_project_location_agent(parent, google_cloud_dialogflow_v2beta1_import_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/agent:import', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_import_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_knowledge_basis_document(parent, google_cloud_dialogflow_v2beta1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation

Create 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_v2beta1_import_documents_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportDocumentsRequest) (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



8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8616

def import_project_location_knowledge_basis_document(parent, google_cloud_dialogflow_v2beta1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/documents:import', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportDocumentsRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_import_documents_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEntityTypesResponse

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

Parameters:

  • parent (String) —

    Required. The agent to list all entity types from. Supported formats: - projects//agent - projects//locations//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



707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 707

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, 'v2beta1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEntityTypesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse

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



1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1160

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, 'v2beta1/{+parent}/intents', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse

Returns the list of all contexts in the specified session.

Parameters:

  • parent (String) —

    Required. The session to list all contexts from. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser 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



1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1405

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, 'v2beta1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse

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. Supported formats:

    • projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser 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



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1611

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, 'v2beta1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse

Returns the list of all non-draft 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



1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1059

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, 'v2beta1/{+parent}/environments', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse

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



1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1907

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, 'v2beta1/{+parent}/intents', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse

Returns the list of all knowledge bases of the specified agent. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects. knowledgeBases.

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



2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2114

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, 'v2beta1/{+parent}/knowledgeBases', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse

Returns the list of all documents of the knowledge base. Note: The projects. agent.knowledgeBases.documents resource is deprecated; only use projects. knowledgeBases.documents.

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



2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2318

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, 'v2beta1/{+parent}/documents', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse

Returns the list of all contexts in the specified session.

Parameters:

  • parent (String) —

    Required. The session to list all contexts from. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser 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



2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2651

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, 'v2beta1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse

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. Supported formats:

    • projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser 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



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

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, 'v2beta1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListVersionsResponse

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



3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3038

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, 'v2beta1/{+parent}/versions', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListVersionsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListVersionsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListAnswerRecordsResponse

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



3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3152

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, 'v2beta1/{+parent}/answerRecords', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListAnswerRecordsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListAnswerRecordsResponse
  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_messages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListMessagesResponse

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



3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3698

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, 'v2beta1/{+parent}/messages', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListMessagesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListMessagesResponse
  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_participant_suggestions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSuggestionsResponse

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See HumanAgentAssistantConfig.name for more details. Removal Date: 2020-09-01. Retrieves suggestions for live agents. This method should be used by human agent client software to fetch auto generated suggestions in real- time, while the conversation with an end user is in progress. The functionality is implemented in terms of the list pagination design pattern. The client app should use the next_page_token field to fetch the next batch of suggestions. suggestions are sorted by create_time in descending order. To fetch latest suggestion, just set page_size to 1. To fetch new suggestions 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 participant to fetch suggestions for. Format: projects//locations//conversations//participants/.

  • filter (String) (defaults to: nil) —

    Optional. Filter on suggestions 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. The default value is 100; the maximum value is 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



3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3969

def list_project_conversation_participant_suggestions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+parent}/suggestions', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSuggestionsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSuggestionsResponse
  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_participants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListParticipantsResponse

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



3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3839

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, 'v2beta1/{+parent}/participants', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListParticipantsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListParticipantsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationProfilesResponse

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



3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3365

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, 'v2beta1/{+parent}/conversationProfiles', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationProfilesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationProfilesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationsResponse

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



3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3615

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, 'v2beta1/{+parent}/conversations', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationsResponse
  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_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse

Returns the list of all knowledge bases of the specified agent. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects. knowledgeBases.

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



4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4301

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, 'v2beta1/{+parent}/knowledgeBases', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse

Returns the list of all documents of the knowledge base. Note: The projects. agent.knowledgeBases.documents resource is deprecated; only use projects. knowledgeBases.documents.

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



4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4544

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, 'v2beta1/{+parent}/documents', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEntityTypesResponse

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

Parameters:

  • parent (String) —

    Required. The agent to list all entity types from. Supported formats: - projects//agent - projects//locations//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



5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5373

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, 'v2beta1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEntityTypesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse

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



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

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, 'v2beta1/{+parent}/intents', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse

Returns the list of all contexts in the specified session.

Parameters:

  • parent (String) —

    Required. The session to list all contexts from. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser 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



6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6071

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, 'v2beta1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse

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. Supported formats:

    • projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser 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



6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6277

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, 'v2beta1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse

Returns the list of all non-draft 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



5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5725

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, 'v2beta1/{+parent}/environments', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListEnvironmentsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse

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



6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6573

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, 'v2beta1/{+parent}/intents', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListIntentsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse

Returns the list of all contexts in the specified session.

Parameters:

  • parent (String) —

    Required. The session to list all contexts from. Supported formats: - projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser 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



6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6867

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, 'v2beta1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListContextsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse

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. Supported formats:

    • projects//agent/sessions/, -projects//locations//agent/sessions/, - projects//agent/environments//users//sessions/, -projects//locations//agent/ environments//users//sessions/, IfLocation IDis not specified we assume default 'us' location. IfEnvironment IDis not specified, we assume default 'draft' environment. IfUser 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



7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7073

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, 'v2beta1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListVersionsResponse

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



7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7254

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, 'v2beta1/{+parent}/versions', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListVersionsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListVersionsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListAnswerRecordsResponse

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



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

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, 'v2beta1/{+parent}/answerRecords', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListAnswerRecordsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListAnswerRecordsResponse
  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_messages(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListMessagesResponse

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



7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7914

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, 'v2beta1/{+parent}/messages', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListMessagesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListMessagesResponse
  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_participants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListParticipantsResponse

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



8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8055

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, 'v2beta1/{+parent}/participants', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListParticipantsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListParticipantsResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationProfilesResponse

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



7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7581

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, 'v2beta1/{+parent}/conversationProfiles', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationProfilesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationProfilesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationsResponse

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



7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7831

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, 'v2beta1/{+parent}/conversations', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListConversationsResponse
  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_bases(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse

Returns the list of all knowledge bases of the specified agent. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects. knowledgeBases.

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



8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8423

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, 'v2beta1/{+parent}/knowledgeBases', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse

Returns the list of all documents of the knowledge base. Note: The projects. agent.knowledgeBases.documents resource is deprecated; only use projects. knowledgeBases.documents.

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



8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8666

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, 'v2beta1/{+parent}/documents', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ListDocumentsResponse
  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::DialogflowV2beta1::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



8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8863

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



4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4768

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, 'v2beta1/{+name}/locations', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudLocationListLocationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::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



9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 9040

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, 'v2beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType

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

  • google_cloud_dialogflow_v2beta1_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType) (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



753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 753

def patch_project_agent_entity_type(name, google_cloud_dialogflow_v2beta1_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType
  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_v2beta1_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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment

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 keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update version in " draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.

Parameters:

  • name (String) —

    Output only. The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/ environments/

  • google_cloud_dialogflow_v2beta1_environment_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment) (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 draft 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 draft 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



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1110

def patch_project_agent_environment(name, google_cloud_dialogflow_v2beta1_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, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_environment_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment
  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_v2beta1_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

Updates the specified context.

Parameters:

  • name (String) —

    Required. The unique identifier of the context. Supported formats: - projects/ /agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/ , - projects//agent/environments//users//sessions//contexts/, - projects// locations//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_v2beta1_context_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context) (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



1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1449

def patch_project_agent_environment_user_session_context(name, google_cloud_dialogflow_v2beta1_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_context_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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_v2beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats:

    • projects//agent/sessions//entityTypes/ - projects//locations//agent/ sessions//entityTypes/ - projects//agent/environments//users//sessions// entityTypes/ - projects//locations//agent/environments/ /users//sessions// entityTypes/ If Location ID is not specified we assume default 'us' location. 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_v2beta1_session_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType) (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



1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 1656

def patch_project_agent_environment_user_session_entity_type(name, google_cloud_dialogflow_v2beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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_v2beta1_intent_object = nil, intent_view: nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent

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

  • google_cloud_dialogflow_v2beta1_intent_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent) (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



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

def patch_project_agent_intent(name, google_cloud_dialogflow_v2beta1_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, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_intent_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent
  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_v2beta1_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase

Updates the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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_v2beta1_knowledge_base_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase) (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



2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2154

def patch_project_agent_knowledge_basis(name, google_cloud_dialogflow_v2beta1_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
  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_v2beta1_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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 Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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_v2beta1_document_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document) (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



2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2362

def patch_project_agent_knowledge_basis_document(name, google_cloud_dialogflow_v2beta1_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_document_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

Updates the specified context.

Parameters:

  • name (String) —

    Required. The unique identifier of the context. Supported formats: - projects/ /agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/ , - projects//agent/environments//users//sessions//contexts/, - projects// locations//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_v2beta1_context_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context) (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



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

def patch_project_agent_session_context(name, google_cloud_dialogflow_v2beta1_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_context_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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_v2beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats:

    • projects//agent/sessions//entityTypes/ - projects//locations//agent/ sessions//entityTypes/ - projects//agent/environments//users//sessions// entityTypes/ - projects//locations//agent/environments/ /users//sessions// entityTypes/ If Location ID is not specified we assume default 'us' location. 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_v2beta1_session_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType) (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



2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2902

def patch_project_agent_session_entity_type(name, google_cloud_dialogflow_v2beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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_v2beta1_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version

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_v2beta1_version_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version) (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



3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3076

def patch_project_agent_version(name, google_cloud_dialogflow_v2beta1_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_version_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version
  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_v2beta1_answer_record_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord

Updates the specified answer record.

Parameters:

  • name (String) —

    The unique identifier of this answer record. Required for AnswerRecords. UpdateAnswerRecord method. Format: projects//locations//answerRecords/.

  • google_cloud_dialogflow_v2beta1_answer_record_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord) (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



3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3189

def patch_project_answer_record(name, google_cloud_dialogflow_v2beta1_answer_record_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_answer_record_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord
  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_v2beta1_participant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant

Updates the specified participant.

Parameters:

  • name (String) —

    Optional. The unique identifier of this participant. Format: projects// locations//conversations//participants/.

  • google_cloud_dialogflow_v2beta1_participant_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant) (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



3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3875

def patch_project_conversation_participant(name, google_cloud_dialogflow_v2beta1_participant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_participant_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant
  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_v2beta1_conversation_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile

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_v2beta1_conversation_profile_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile) (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



3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3403

def patch_project_conversation_profile(name, google_cloud_dialogflow_v2beta1_conversation_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_conversation_profile_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile
  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_v2beta1_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase

Updates the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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_v2beta1_knowledge_base_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase) (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



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

def patch_project_knowledge_basis(name, google_cloud_dialogflow_v2beta1_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
  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_v2beta1_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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 Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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_v2beta1_document_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document) (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



4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4588

def patch_project_knowledge_basis_document(name, google_cloud_dialogflow_v2beta1_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_document_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType

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

  • google_cloud_dialogflow_v2beta1_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType) (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



5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5419

def patch_project_location_agent_entity_type(name, google_cloud_dialogflow_v2beta1_entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType
  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_v2beta1_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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment

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 keeps on serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update version in " draft" environment. WARNING: this will negate all recent changes to draft and can't be undone. You may want to save the draft to a version before calling this function.

Parameters:

  • name (String) —

    Output only. The unique identifier of this agent environment. Supported formats: - projects//agent/environments/ - projects//locations//agent/ environments/

  • google_cloud_dialogflow_v2beta1_environment_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment) (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 draft 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 draft 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



5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5776

def patch_project_location_agent_environment(name, google_cloud_dialogflow_v2beta1_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, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_environment_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Environment
  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_v2beta1_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

Updates the specified context.

Parameters:

  • name (String) —

    Required. The unique identifier of the context. Supported formats: - projects/ /agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/ , - projects//agent/environments//users//sessions//contexts/, - projects// locations//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_v2beta1_context_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context) (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



6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6115

def patch_project_location_agent_environment_user_session_context(name, google_cloud_dialogflow_v2beta1_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_context_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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_v2beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats:

    • projects//agent/sessions//entityTypes/ - projects//locations//agent/ sessions//entityTypes/ - projects//agent/environments//users//sessions// entityTypes/ - projects//locations//agent/environments/ /users//sessions// entityTypes/ If Location ID is not specified we assume default 'us' location. 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_v2beta1_session_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType) (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



6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6322

def patch_project_location_agent_environment_user_session_entity_type(name, google_cloud_dialogflow_v2beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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_v2beta1_intent_object = nil, intent_view: nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent

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

  • google_cloud_dialogflow_v2beta1_intent_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent) (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



6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6621

def patch_project_location_agent_intent(name, google_cloud_dialogflow_v2beta1_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, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_intent_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent
  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_v2beta1_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context

Updates the specified context.

Parameters:

  • name (String) —

    Required. The unique identifier of the context. Supported formats: - projects/ /agent/sessions//contexts/, - projects//locations//agent/sessions//contexts/ , - projects//agent/environments//users//sessions//contexts/, - projects// locations//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_v2beta1_context_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context) (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



6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 6911

def patch_project_location_agent_session_context(name, google_cloud_dialogflow_v2beta1_context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_context_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context
  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_v2beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType

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. Supported formats:

    • projects//agent/sessions//entityTypes/ - projects//locations//agent/ sessions//entityTypes/ - projects//agent/environments//users//sessions// entityTypes/ - projects//locations//agent/environments/ /users//sessions// entityTypes/ If Location ID is not specified we assume default 'us' location. 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_v2beta1_session_entity_type_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType) (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



7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7118

def patch_project_location_agent_session_entity_type(name, google_cloud_dialogflow_v2beta1_session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_session_entity_type_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType
  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_v2beta1_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version

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_v2beta1_version_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version) (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



7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7292

def patch_project_location_agent_version(name, google_cloud_dialogflow_v2beta1_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_version_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Version
  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_v2beta1_answer_record_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord

Updates the specified answer record.

Parameters:

  • name (String) —

    The unique identifier of this answer record. Required for AnswerRecords. UpdateAnswerRecord method. Format: projects//locations//answerRecords/.

  • google_cloud_dialogflow_v2beta1_answer_record_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord) (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



7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7405

def patch_project_location_answer_record(name, google_cloud_dialogflow_v2beta1_answer_record_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_answer_record_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnswerRecord
  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_v2beta1_participant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant

Updates the specified participant.

Parameters:

  • name (String) —

    Optional. The unique identifier of this participant. Format: projects// locations//conversations//participants/.

  • google_cloud_dialogflow_v2beta1_participant_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant) (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



8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8091

def patch_project_location_conversation_participant(name, google_cloud_dialogflow_v2beta1_participant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_participant_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant
  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_v2beta1_conversation_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile

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_v2beta1_conversation_profile_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile) (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



7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7619

def patch_project_location_conversation_profile(name, google_cloud_dialogflow_v2beta1_conversation_profile_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_conversation_profile_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ConversationProfile
  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_v2beta1_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase

Updates the specified knowledge base. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

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_v2beta1_knowledge_base_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase) (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



8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8463

def patch_project_location_knowledge_basis(name, google_cloud_dialogflow_v2beta1_knowledge_base_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_knowledge_base_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase
  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_v2beta1_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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 Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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_v2beta1_document_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document) (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



8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8710

def patch_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2beta1_document_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_document_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the import_gcs_custom_metadata field is set to true in the request. 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_v2beta1_reload_document_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest) (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



2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 2408

def reload_project_agent_knowledge_basis_document(name, google_cloud_dialogflow_v2beta1_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+name}:reload', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_reload_document_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the import_gcs_custom_metadata field is set to true in the request. 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_v2beta1_reload_document_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest) (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



4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4634

def reload_project_knowledge_basis_document(name, google_cloud_dialogflow_v2beta1_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+name}:reload', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_reload_document_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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. Note: If the document source is Google Cloud Storage URI, its metadata will be replaced with the custom metadata from Google Cloud Storage if the import_gcs_custom_metadata field is set to true in the request. 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_v2beta1_reload_document_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest) (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



8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8756

def reload_project_location_knowledge_basis_document(name, google_cloud_dialogflow_v2beta1_reload_document_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+name}:reload', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_reload_document_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_agent(parent, google_cloud_dialogflow_v2beta1_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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/ or projects//locations/.

  • google_cloud_dialogflow_v2beta1_restore_agent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1RestoreAgentRequest) (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



347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 347

def restore_agent(parent, google_cloud_dialogflow_v2beta1_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/agent:restore', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1RestoreAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_restore_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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/ or projects//locations/.

  • google_cloud_dialogflow_v2beta1_restore_agent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1RestoreAgentRequest) (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



5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5013

def restore_project_location_agent(parent, google_cloud_dialogflow_v2beta1_restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/agent:restore', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1RestoreAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_restore_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchAgentsResponse

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/ or projects// locations/.

  • 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



389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 389

def search_project_agents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+parent}/agent:search', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchAgentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchAgentsResponse
  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_v2beta1_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse

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_v2beta1_search_knowledge_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeRequest) (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



4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4110

def search_project_conversation_suggestion_knowledge(conversation, google_cloud_dialogflow_v2beta1_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+conversation}/suggestions:searchKnowledge', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_search_knowledge_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse
  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::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchAgentsResponse

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/ or projects// locations/.

  • 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



5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5055

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, 'v2beta1/{+parent}/agent:search', options)
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchAgentsResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchAgentsResponse
  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_v2beta1_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse

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_v2beta1_search_knowledge_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeRequest) (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



8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8232

def search_project_location_conversation_suggestion_knowledge(conversation, google_cloud_dialogflow_v2beta1_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+conversation}/suggestions:searchKnowledge', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_search_knowledge_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse
  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_v2beta1_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse

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_v2beta1_search_knowledge_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeRequest) (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



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

def search_project_location_suggestion_knowledge(parent, google_cloud_dialogflow_v2beta1_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:searchKnowledge', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_search_knowledge_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse
  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_v2beta1_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse

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_v2beta1_search_knowledge_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeRequest) (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



9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 9110

def search_project_suggestion_knowledge(parent, google_cloud_dialogflow_v2beta1_search_knowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:searchKnowledge', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_search_knowledge_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SearchKnowledgeResponse
  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_v2beta1_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent

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/ or projects// locations/

  • google_cloud_dialogflow_v2beta1_agent_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent) (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



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 141

def set_project_agent(parent, google_cloud_dialogflow_v2beta1_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/agent', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_agent_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent
  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_v2beta1_set_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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_v2beta1_set_suggestion_feature_config_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigRequest) (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



3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 3448

def set_project_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2beta1_set_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+conversationProfile}:setSuggestionFeatureConfig', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_set_suggestion_feature_config_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent

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/ or projects// locations/

  • google_cloud_dialogflow_v2beta1_agent_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent) (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



4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4807

def set_project_location_agent(parent, google_cloud_dialogflow_v2beta1_agent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/agent', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_agent_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent
  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_v2beta1_set_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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_v2beta1_set_suggestion_feature_config_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigRequest) (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



7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 7664

def set_project_location_conversation_profile_suggestion_feature_config(conversation_profile, google_cloud_dialogflow_v2beta1_set_suggestion_feature_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+conversationProfile}:setSuggestionFeatureConfig', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SetSuggestionFeatureConfigRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_set_suggestion_feature_config_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_suggest_articles_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestArticlesResponse

Gets suggested articles for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Parameters:

  • parent (String) —

    Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.

  • google_cloud_dialogflow_v2beta1_suggest_articles_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestArticlesRequest) (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



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

def suggest_project_conversation_participant_suggestion_articles(parent, google_cloud_dialogflow_v2beta1_suggest_articles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:suggestArticles', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestArticlesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_suggest_articles_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestArticlesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestArticlesResponse
  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_v2beta1_suggest_faq_answers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse

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_v2beta1_suggest_faq_answers_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest) (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



4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4042

def suggest_project_conversation_participant_suggestion_faq_answers(parent, google_cloud_dialogflow_v2beta1_suggest_faq_answers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:suggestFaqAnswers', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_suggest_faq_answers_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse
  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_v2beta1_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse

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_v2beta1_suggest_smart_replies_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesRequest) (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



4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4076

def suggest_project_conversation_participant_suggestion_smart_replies(parent, google_cloud_dialogflow_v2beta1_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:suggestSmartReplies', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_suggest_smart_replies_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse
  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_v2beta1_suggest_conversation_summary_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponse

Suggest 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_v2beta1_suggest_conversation_summary_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest) (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



4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 4145

def suggest_project_conversation_suggestion_conversation_summary(conversation, google_cloud_dialogflow_v2beta1_suggest_conversation_summary_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+conversation}/suggestions:suggestConversationSummary', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_suggest_conversation_summary_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponse
  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_v2beta1_suggest_articles_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestArticlesResponse

Gets suggested articles for a participant based on specific historical messages. Note that ListSuggestions will only list the auto-generated suggestions, while CompileSuggestion will try to compile suggestion based on the provided conversation context in the real time.

Parameters:

  • parent (String) —

    Required. The name of the participant to fetch suggestion for. Format: projects//locations//conversations//participants/.

  • google_cloud_dialogflow_v2beta1_suggest_articles_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestArticlesRequest) (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



8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8129

def suggest_project_location_conversation_participant_suggestion_articles(parent, google_cloud_dialogflow_v2beta1_suggest_articles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:suggestArticles', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestArticlesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_suggest_articles_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestArticlesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestArticlesResponse
  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_v2beta1_suggest_faq_answers_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse

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_v2beta1_suggest_faq_answers_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest) (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



8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8164

def suggest_project_location_conversation_participant_suggestion_faq_answers(parent, google_cloud_dialogflow_v2beta1_suggest_faq_answers_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:suggestFaqAnswers', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_suggest_faq_answers_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse
  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_v2beta1_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse

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_v2beta1_suggest_smart_replies_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesRequest) (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



8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8198

def suggest_project_location_conversation_participant_suggestion_smart_replies(parent, google_cloud_dialogflow_v2beta1_suggest_smart_replies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/suggestions:suggestSmartReplies', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_suggest_smart_replies_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestSmartRepliesResponse
  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_v2beta1_suggest_conversation_summary_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponse

Suggest 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_v2beta1_suggest_conversation_summary_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest) (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



8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 8267

def suggest_project_location_conversation_suggestion_conversation_summary(conversation, google_cloud_dialogflow_v2beta1_suggest_conversation_summary_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+conversation}/suggestions:suggestConversationSummary', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_suggest_conversation_summary_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponse::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SuggestConversationSummaryResponse
  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_agent(parent, google_cloud_dialogflow_v2beta1_train_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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/ or projects//locations/.

  • google_cloud_dialogflow_v2beta1_train_agent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1TrainAgentRequest) (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



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

def train_agent(parent, google_cloud_dialogflow_v2beta1_train_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/agent:train', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1TrainAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_train_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::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_v2beta1_train_agent_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::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/ or projects//locations/.

  • google_cloud_dialogflow_v2beta1_train_agent_request_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1TrainAgentRequest) (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



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

def train_project_location_agent(parent, google_cloud_dialogflow_v2beta1_train_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/agent:train', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1TrainAgentRequest::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_train_agent_request_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_agent_fulfillment(name, google_cloud_dialogflow_v2beta1_fulfillment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment

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_v2beta1_fulfillment_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment) (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



468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 468

def update_project_agent_fulfillment(name, google_cloud_dialogflow_v2beta1_fulfillment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_fulfillment_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment
  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_v2beta1_fulfillment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment

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_v2beta1_fulfillment_object (Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment) (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



5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
 
# File 'lib/google/apis/dialogflow_v2beta1/service.rb', line 5134

def update_project_location_agent_fulfillment(name, google_cloud_dialogflow_v2beta1_fulfillment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment::Representation
  command.request_object = google_cloud_dialogflow_v2beta1_fulfillment_object
  command.response_representation = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment::Representation
  command.response_class = Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment
  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