Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Conversation
- 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
-
#conversation_profile ⇒ String
Required.
-
#conversation_stage ⇒ String
Optional.
-
#end_time ⇒ String
Output only.
-
#lifecycle_state ⇒ String
Output only.
-
#name ⇒ String
Output only.
-
#phone_number ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ConversationPhoneNumber
Represents a phone number for telephony integration.
-
#start_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2Conversation
constructor
A new instance of GoogleCloudDialogflowV2Conversation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2Conversation
Returns a new instance of GoogleCloudDialogflowV2Conversation.
9003 9004 9005 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9003 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
8961 8962 8963 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 8961 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
8974 8975 8976 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 8974 def conversation_stage @conversation_stage end |
#end_time ⇒ String
Output only. The time the conversation was finished.
Corresponds to the JSON property endTime
8979 8980 8981 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 8979 def end_time @end_time end |
#lifecycle_state ⇒ String
Output only. The current state of the Conversation.
Corresponds to the JSON property lifecycleState
8984 8985 8986 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 8984 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
8990 8991 8992 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 8990 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
8996 8997 8998 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 8996 def phone_number @phone_number end |
#start_time ⇒ String
Output only. The time the conversation was started.
Corresponds to the JSON property startTime
9001 9002 9003 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9001 def start_time @start_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9008 9009 9010 9011 9012 9013 9014 9015 9016 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 9008 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) @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) end |