Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/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) ⇒ GoogleCloudDialogflowV2Participant

Returns a new instance of GoogleCloudDialogflowV2Participant.



15966
15967
15968
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 15966

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) 


15917
15918
15919
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 15917

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


15929
15930
15931
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 15929

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) 


15935
15936
15937
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 15935

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 returns an error if you try to add a user id for a non-END_USER participant. Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation. 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) 


15951
15952
15953
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 15951

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) 


15957
15958
15959
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 15957

def role
  @role
end

#sip_recording_media_label ⇒ String

Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated. Corresponds to the JSON property sipRecordingMediaLabel

Returns:

  • (String) 


15964
15965
15966
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 15964

def sip_recording_media_label
  @sip_recording_media_label
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15971
15972
15973
15974
15975
15976
15977
15978
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 15971

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)
  @sip_recording_media_label = args[:sip_recording_media_label] if args.key?(:sip_recording_media_label)
end