Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Participant

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2beta1/classes.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb

Overview

Represents a conversation participant (human agent, virtual agent, end-user).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Participant

Returns a new instance of GoogleCloudDialogflowV2beta1Participant.



12655
12656
12657
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12655

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#name ⇒ String

Optional. The unique identifier of this participant. Format: projects// locations//conversations//participants/. Corresponds to the JSON property name

Returns:

  • (String) 


12629
12630
12631
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12629

def name
  @name
end

#obfuscated_external_user_id ⇒ String

Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows: 1. If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant. 2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant. obfuscated_external_user_id. Dialogflow uses this user id for following purposes: 1) Billing and measurement. If user with the same obfuscated_external_user_id is created in a later conversation, dialogflow will know it's the same user. 2) Agent assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user. Note: * Please never pass raw user ids to Dialogflow. Always obfuscate your user id first. * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512. * The length of the user id must be <= 256 characters. Corresponds to the JSON property obfuscatedExternalUserId

Returns:

  • (String) 


12647
12648
12649
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12647

def obfuscated_external_user_id
  @obfuscated_external_user_id
end

#role ⇒ String

Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable. Corresponds to the JSON property role

Returns:

  • (String) 


12653
12654
12655
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12653

def role
  @role
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12660
12661
12662
12663
12664
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12660

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @obfuscated_external_user_id = args[:obfuscated_external_user_id] if args.key?(:obfuscated_external_user_id)
  @role = args[:role] if args.key?(:role)
end