Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Conversation.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#conversation_profile
def conversation_profile() -> ::String-
(::String) — Required. The Conversation Profile to be used to configure this
Conversation. This field cannot be updated.
Format:
projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.
#conversation_profile=
def conversation_profile=(value) -> ::String-
value (::String) — Required. The Conversation Profile to be used to configure this
Conversation. This field cannot be updated.
Format:
projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.
-
(::String) — Required. The Conversation Profile to be used to configure this
Conversation. This field cannot be updated.
Format:
projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.
#conversation_stage
def conversation_stage() -> ::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage-
(::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage) — 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.
#conversation_stage=
def conversation_stage=(value) -> ::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage-
value (::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage) — 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.
-
(::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage) — 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.
#end_time
def end_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. The time the conversation was finished.
#lifecycle_state
def lifecycle_state() -> ::Google::Cloud::Dialogflow::V2::Conversation::LifecycleState- (::Google::Cloud::Dialogflow::V2::Conversation::LifecycleState) — Output only. The current state of the Conversation.
#name
def name() -> ::String-
(::String) — Output only. The unique identifier of this conversation.
Format:
projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.
#phone_number
def phone_number() -> ::Google::Cloud::Dialogflow::V2::ConversationPhoneNumber- (::Google::Cloud::Dialogflow::V2::ConversationPhoneNumber) — Output only. It will not be empty if the conversation is to be connected over telephony.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. The time the conversation was started.