Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation

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. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2Conversation

Returns a new instance of GoogleCloudDialogflowV2Conversation.



9565
9566
9567
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9565

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

Instance Attribute Details

#conversation_profile ⇒ String

Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations// conversationProfiles/. Corresponds to the JSON property conversationProfile

Returns:

  • (String) 


9512
9513
9514
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9512

def conversation_profile
  @conversation_profile
end

#conversation_stage ⇒ String

Optional. The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE. Corresponds to the JSON property conversationStage

Returns:

  • (String) 


9525
9526
9527
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9525

def conversation_stage
  @conversation_stage
end

#end_time ⇒ String

Output only. The time the conversation was finished. Corresponds to the JSON property endTime

Returns:

  • (String) 


9530
9531
9532
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9530

def end_time
  @end_time
end

#ingested_context_references ⇒ Hash<String,Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationContextReference>

Output only. The context reference updates provided by external systems. Corresponds to the JSON property ingestedContextReferences

Returns:



9535
9536
9537
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9535

def ingested_context_references
  @ingested_context_references
end

#lifecycle_state ⇒ String

Output only. The current state of the Conversation. Corresponds to the JSON property lifecycleState

Returns:

  • (String) 


9540
9541
9542
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9540

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

Output only. Identifier. The unique identifier of this conversation. Format: projects//locations//conversations/. Corresponds to the JSON property name

Returns:

  • (String) 


9546
9547
9548
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9546

def name
  @name
end

#phone_number ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationPhoneNumber

Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony. Corresponds to the JSON property phoneNumber

Returns:



9552
9553
9554
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9552

def phone_number
  @phone_number
end

#start_time ⇒ String

Output only. The time the conversation was started. Corresponds to the JSON property startTime

Returns:

  • (String) 


9557
9558
9559
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9557

def start_time
  @start_time
end

#telephony_connection_info ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationTelephonyConnectionInfo

The information about phone calls connected via phone gateway to the conversation. Corresponds to the JSON property telephonyConnectionInfo

Returns:



9563
9564
9565
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9563

def telephony_connection_info
  @telephony_connection_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9570

def update!(**args)
  @conversation_profile = args[:conversation_profile] if args.key?(:conversation_profile)
  @conversation_stage = args[:conversation_stage] if args.key?(:conversation_stage)
  @end_time = args[:end_time] if args.key?(:end_time)
  @ingested_context_references = args[:ingested_context_references] if args.key?(:ingested_context_references)
  @lifecycle_state = args[:lifecycle_state] if args.key?(:lifecycle_state)
  @name = args[:name] if args.key?(:name)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @start_time = args[:start_time] if args.key?(:start_time)
  @telephony_connection_info = args[:telephony_connection_info] if args.key?(:telephony_connection_info)
end