Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationProfile

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

Defines the services to connect to incoming Dialogflow conversations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2ConversationProfile

Returns a new instance of GoogleCloudDialogflowV2ConversationProfile.



6899
6900
6901
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6899

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

Instance Attribute Details

#automated_agent_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2AutomatedAgentConfig

Defines the Automated Agent to connect to a conversation. Corresponds to the JSON property automatedAgentConfig

Returns:



6823
6824
6825
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6823

def automated_agent_config
  @automated_agent_config
end

#create_time ⇒ String

Output only. Create time of the conversation profile. Corresponds to the JSON property createTime

Returns:

  • (String) 


6828
6829
6830
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6828

def create_time
  @create_time
end

#display_name ⇒ String

Required. Human readable name for this profile. Max length 1024 bytes. Corresponds to the JSON property displayName

Returns:

  • (String) 


6833
6834
6835
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6833

def display_name
  @display_name
end

#human_agent_assistant_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentAssistantConfig

Defines the Human Agent Assist to connect to a conversation. Corresponds to the JSON property humanAgentAssistantConfig

Returns:



6838
6839
6840
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6838

def human_agent_assistant_config
  @human_agent_assistant_config
end

#human_agent_handoff_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2HumanAgentHandoffConfig

Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access. Corresponds to the JSON property humanAgentHandoffConfig

Returns:



6845
6846
6847
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6845

def human_agent_handoff_config
  @human_agent_handoff_config
end

#language_code ⇒ String

Language code for the conversation profile. If not specified, the language is en-US. Language at ConversationProfile should be set for all non en-US languages. This should be a BCP-47 language tag. Example: "en-US". Corresponds to the JSON property languageCode

Returns:

  • (String) 


6853
6854
6855
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6853

def language_code
  @language_code
end

#logging_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2LoggingConfig

Defines logging behavior for conversation lifecycle events. Corresponds to the JSON property loggingConfig

Returns:



6858
6859
6860
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6858

def logging_config
  @logging_config
end

#name ⇒ String

The unique identifier of this conversation profile. Format: projects// locations//conversationProfiles/. Corresponds to the JSON property name

Returns:

  • (String) 


6864
6865
6866
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6864

def name
  @name
end

#new_message_event_notification_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2NotificationConfig

Defines notification behavior. Corresponds to the JSON property newMessageEventNotificationConfig

Returns:



6869
6870
6871
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6869

def new_message_event_notification_config
  @new_message_event_notification_config
end

#notification_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2NotificationConfig

Defines notification behavior. Corresponds to the JSON property notificationConfig

Returns:



6874
6875
6876
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6874

def notification_config
  @notification_config
end

#security_settings ⇒ String

Name of the CX SecuritySettings reference for the agent. Format: projects// locations//securitySettings/. Corresponds to the JSON property securitySettings

Returns:

  • (String) 


6880
6881
6882
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6880

def security_settings
  @security_settings
end

#stt_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SpeechToTextConfig

Configures speech transcription for ConversationProfile. Corresponds to the JSON property sttConfig

Returns:



6885
6886
6887
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6885

def stt_config
  @stt_config
end

#time_zone ⇒ String

The time zone of this conversational profile from the time zone database, e.g., America/New_York, Europe/Paris. Defaults to America/New_York. Corresponds to the JSON property timeZone

Returns:

  • (String) 


6892
6893
6894
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6892

def time_zone
  @time_zone
end

#update_time ⇒ String

Output only. Update time of the conversation profile. Corresponds to the JSON property updateTime

Returns:

  • (String) 


6897
6898
6899
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6897

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 6904

def update!(**args)
  @automated_agent_config = args[:automated_agent_config] if args.key?(:automated_agent_config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @human_agent_assistant_config = args[:human_agent_assistant_config] if args.key?(:human_agent_assistant_config)
  @human_agent_handoff_config = args[:human_agent_handoff_config] if args.key?(:human_agent_handoff_config)
  @language_code = args[:language_code] if args.key?(:language_code)
  @logging_config = args[:logging_config] if args.key?(:logging_config)
  @name = args[:name] if args.key?(:name)
  @new_message_event_notification_config = args[:new_message_event_notification_config] if args.key?(:new_message_event_notification_config)
  @notification_config = args[:notification_config] if args.key?(:notification_config)
  @security_settings = args[:security_settings] if args.key?(:security_settings)
  @stt_config = args[:stt_config] if args.key?(:stt_config)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @update_time = args[:update_time] if args.key?(:update_time)
end