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

Inherits:

Object

• Object
• Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Participant

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

• #documents_metadata_filters ⇒ Hash<String,String>

  Optional.

• #name ⇒ String

  Optional.

• #obfuscated_external_user_id ⇒ String

  Optional.

• #role ⇒ String

  Immutable.

• #sip_recording_media_label ⇒ String

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDialogflowV2Participant constructor

  A new instance of GoogleCloudDialogflowV2Participant.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2Participant

Returns a new instance of GoogleCloudDialogflowV2Participant.

# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11698

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

Instance Attribute Details

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

# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11661

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)

# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11667

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)

# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11683

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)

# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11689

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)

# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11696

def sip_recording_media_label
  @sip_recording_media_label
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11703

def update!(**args)
  @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