Class: Google::Apis::CesV1::ChannelProfile

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

Overview

A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ChannelProfile

Returns a new instance of ChannelProfile.



1482
1483
1484
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1482

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

Instance Attribute Details

#channel_type ⇒ String

Optional. The type of the channel profile. Corresponds to the JSON property channelType

Returns:

  • (String) 


1435
1436
1437
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1435

def channel_type
  @channel_type
end

#disable_barge_in_control ⇒ Boolean Also known as: disable_barge_in_control?

Optional. Whether to disable user barge-in control in the conversation. - ** true*: User interruptions are disabled while the agent is speaking. - **false *: The agent retains automatic control over when the user can interrupt. Corresponds to the JSON property disableBargeInControl

Returns:

  • (Boolean) 


1442
1443
1444
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1442

def disable_barge_in_control
  @disable_barge_in_control
end

#disable_dtmf ⇒ Boolean Also known as: disable_dtmf?

Optional. Whether to disable DTMF (dual-tone multi-frequency). Corresponds to the JSON property disableDtmf

Returns:

  • (Boolean) 


1448
1449
1450
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1448

def disable_dtmf
  @disable_dtmf
end

#instagram_config ⇒ Google::Apis::CesV1::ChannelProfileInstagramConfig

Configuration specific to Instagram deployments. Corresponds to the JSON property instagramConfig

Returns:



1454
1455
1456
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1454

def instagram_config
  @instagram_config
end

#noise_suppression_level ⇒ String

Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". Corresponds to the JSON property noiseSuppressionLevel

Returns:

  • (String) 


1460
1461
1462
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1460

def noise_suppression_level
  @noise_suppression_level
end

#persona_property ⇒ Google::Apis::CesV1::ChannelProfilePersonaProperty

Represents the persona property of a channel. Corresponds to the JSON property personaProperty

Returns:



1465
1466
1467
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1465

def persona_property
  @persona_property
end

#profile_id ⇒ String

Optional. The unique identifier of the channel profile. Corresponds to the JSON property profileId

Returns:

  • (String) 


1470
1471
1472
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1470

def profile_id
  @profile_id
end

#web_widget_config ⇒ Google::Apis::CesV1::ChannelProfileWebWidgetConfig

Message for configuration for the web widget. Corresponds to the JSON property webWidgetConfig

Returns:



1475
1476
1477
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1475

def web_widget_config
  @web_widget_config
end

#whatsapp_config ⇒ Google::Apis::CesV1::ChannelProfileWhatsAppConfig

Configuration specific to WhatsApp deployments. Corresponds to the JSON property whatsappConfig

Returns:



1480
1481
1482
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1480

def whatsapp_config
  @whatsapp_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
 
# File 'lib/google/apis/ces_v1/classes.rb', line 1487

def update!(**args)
  @channel_type = args[:channel_type] if args.key?(:channel_type)
  @disable_barge_in_control = args[:disable_barge_in_control] if args.key?(:disable_barge_in_control)
  @disable_dtmf = args[:disable_dtmf] if args.key?(:disable_dtmf)
  @instagram_config = args[:instagram_config] if args.key?(:instagram_config)
  @noise_suppression_level = args[:noise_suppression_level] if args.key?(:noise_suppression_level)
  @persona_property = args[:persona_property] if args.key?(:persona_property)
  @profile_id = args[:profile_id] if args.key?(:profile_id)
  @web_widget_config = args[:web_widget_config] if args.key?(:web_widget_config)
  @whatsapp_config = args[:whatsapp_config] if args.key?(:whatsapp_config)
end