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.



20213
20214
20215
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 20213

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

Instance Attribute Details

#agent_desktop_source ⇒ String

Optional. For tracking the utilization of prebuilt Agent Assist integration modules. This field is only inscope for Integration type that include UI Modules, Backend Modules, and Agent Desktop connector, it is out of scope for CCaaS and Direct Integration. For each human agent, prebuilt UI Modules needs to trigger the UpdateParticipant API to update this field. Both CreateParticipantRequest and UpdateParticipantRequest will be supported. Corresponds to the JSON property agentDesktopSource

Returns:

  • (String) 


20169
20170
20171
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 20169

def agent_desktop_source
  @agent_desktop_source
end

#documents_metadata_filters ⇒ Hash<String,String>

Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and ' agent' in their user metadata values will be documents_metadata_filters ` key: "market" value: "US,CA" ` documents_metadata_filters ` key: "user" value: "agent" ` Corresponds to the JSON property documentsMetadataFilters

Returns:

  • (Hash<String,String>) 


20181
20182
20183
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 20181

def documents_metadata_filters
  @documents_metadata_filters
end

#name ⇒ String

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

Returns:

  • (String) 


20187
20188
20189
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 20187

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 billing and measurement. If a user with the same obfuscated_external_user_id is created in a later conversation, Dialogflow will know it's the same user. Dialogflow also uses this user id for 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) 


20205
20206
20207
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 20205

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) 


20211
20212
20213
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 20211

def role
  @role
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20218
20219
20220
20221
20222
20223
20224
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 20218

def update!(**args)
  @agent_desktop_source = args[:agent_desktop_source] if args.key?(:agent_desktop_source)
  @documents_metadata_filters = args[:documents_metadata_filters] if args.key?(:documents_metadata_filters)
  @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