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.



11400
11401
11402
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11400

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


11379
11380
11381
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11379

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) 


11385
11386
11387
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11385

def name
  @name
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) 


11391
11392
11393
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11391

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) 


11398
11399
11400
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11398

def sip_recording_media_label
  @sip_recording_media_label
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11405
11406
11407
11408
11409
11410
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11405

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