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.



9248
9249
9250
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9248

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:



9162
9163
9164
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9162

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) 


9167
9168
9169
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9167

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) 


9172
9173
9174
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9172

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:



9177
9178
9179
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9177

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:



9184
9185
9186
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9184

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) 


9192
9193
9194
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9192

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:



9197
9198
9199
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9197

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) 


9203
9204
9205
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9203

def name
  @name
end

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

Defines notification behavior. Corresponds to the JSON property newMessageEventNotificationConfig

Returns:



9208
9209
9210
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9208

def new_message_event_notification_config
  @new_message_event_notification_config
end

#new_recognition_result_notification_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2NotificationConfig

Defines notification behavior. Corresponds to the JSON property newRecognitionResultNotificationConfig

Returns:



9213
9214
9215
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9213

def new_recognition_result_notification_config
  @new_recognition_result_notification_config
end

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

Defines notification behavior. Corresponds to the JSON property notificationConfig

Returns:



9218
9219
9220
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9218

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) 


9224
9225
9226
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9224

def security_settings
  @security_settings
end

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

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

Returns:



9229
9230
9231
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9229

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) 


9236
9237
9238
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9236

def time_zone
  @time_zone
end

#tts_config ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SynthesizeSpeechConfig

Configuration of how speech should be synthesized. Corresponds to the JSON property ttsConfig

Returns:



9241
9242
9243
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9241

def tts_config
  @tts_config
end

#update_time ⇒ String

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

Returns:

  • (String) 


9246
9247
9248
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9246

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9253

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