Class: Google::Cloud::Dialogflow::V2::Conversation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/conversation.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.

Defined Under Namespace

Modules: ConversationStage, LifecycleState

Instance Attribute Summary collapse

Instance Attribute Details

#conversation_profile ⇒ ::String

Returns 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>.

Returns:

  • (::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>.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 70

class Conversation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enumeration of the completion status of the conversation.
  module LifecycleState
    # Unknown.
    LIFECYCLE_STATE_UNSPECIFIED = 0

    # Conversation is currently open for media analysis.
    IN_PROGRESS = 1

    # Conversation has been completed.
    COMPLETED = 2
  end

  # Enumeration of the different conversation stages a conversation can be in.
  # Reference:
  # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
  module ConversationStage
    # Unknown. Should never be used after a conversation is successfully
    # created.
    CONVERSATION_STAGE_UNSPECIFIED = 0

    # The conversation should return virtual agent responses into the
    # conversation.
    VIRTUAL_AGENT_STAGE = 1

    # The conversation should not provide responses, just listen and provide
    # suggestions.
    HUMAN_ASSIST_STAGE = 2
  end
end

#conversation_stage ⇒ ::Google::Cloud::Dialogflow::V2::Conversation::ConversationStage

Returns 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.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 70

class Conversation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enumeration of the completion status of the conversation.
  module LifecycleState
    # Unknown.
    LIFECYCLE_STATE_UNSPECIFIED = 0

    # Conversation is currently open for media analysis.
    IN_PROGRESS = 1

    # Conversation has been completed.
    COMPLETED = 2
  end

  # Enumeration of the different conversation stages a conversation can be in.
  # Reference:
  # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
  module ConversationStage
    # Unknown. Should never be used after a conversation is successfully
    # created.
    CONVERSATION_STAGE_UNSPECIFIED = 0

    # The conversation should return virtual agent responses into the
    # conversation.
    VIRTUAL_AGENT_STAGE = 1

    # The conversation should not provide responses, just listen and provide
    # suggestions.
    HUMAN_ASSIST_STAGE = 2
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the conversation was finished.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 70

class Conversation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enumeration of the completion status of the conversation.
  module LifecycleState
    # Unknown.
    LIFECYCLE_STATE_UNSPECIFIED = 0

    # Conversation is currently open for media analysis.
    IN_PROGRESS = 1

    # Conversation has been completed.
    COMPLETED = 2
  end

  # Enumeration of the different conversation stages a conversation can be in.
  # Reference:
  # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
  module ConversationStage
    # Unknown. Should never be used after a conversation is successfully
    # created.
    CONVERSATION_STAGE_UNSPECIFIED = 0

    # The conversation should return virtual agent responses into the
    # conversation.
    VIRTUAL_AGENT_STAGE = 1

    # The conversation should not provide responses, just listen and provide
    # suggestions.
    HUMAN_ASSIST_STAGE = 2
  end
end

#lifecycle_state ⇒ ::Google::Cloud::Dialogflow::V2::Conversation::LifecycleState (readonly)

Returns Output only. The current state of the Conversation.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 70

class Conversation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enumeration of the completion status of the conversation.
  module LifecycleState
    # Unknown.
    LIFECYCLE_STATE_UNSPECIFIED = 0

    # Conversation is currently open for media analysis.
    IN_PROGRESS = 1

    # Conversation has been completed.
    COMPLETED = 2
  end

  # Enumeration of the different conversation stages a conversation can be in.
  # Reference:
  # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
  module ConversationStage
    # Unknown. Should never be used after a conversation is successfully
    # created.
    CONVERSATION_STAGE_UNSPECIFIED = 0

    # The conversation should return virtual agent responses into the
    # conversation.
    VIRTUAL_AGENT_STAGE = 1

    # The conversation should not provide responses, just listen and provide
    # suggestions.
    HUMAN_ASSIST_STAGE = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Identifier. The unique identifier of this conversation. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

Returns:

  • (::String) —

    Output only. Identifier. The unique identifier of this conversation. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 70

class Conversation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enumeration of the completion status of the conversation.
  module LifecycleState
    # Unknown.
    LIFECYCLE_STATE_UNSPECIFIED = 0

    # Conversation is currently open for media analysis.
    IN_PROGRESS = 1

    # Conversation has been completed.
    COMPLETED = 2
  end

  # Enumeration of the different conversation stages a conversation can be in.
  # Reference:
  # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
  module ConversationStage
    # Unknown. Should never be used after a conversation is successfully
    # created.
    CONVERSATION_STAGE_UNSPECIFIED = 0

    # The conversation should return virtual agent responses into the
    # conversation.
    VIRTUAL_AGENT_STAGE = 1

    # The conversation should not provide responses, just listen and provide
    # suggestions.
    HUMAN_ASSIST_STAGE = 2
  end
end

#phone_number ⇒ ::Google::Cloud::Dialogflow::V2::ConversationPhoneNumber (readonly)

Returns Output only. It will not be empty if the conversation is to be connected over telephony.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 70

class Conversation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enumeration of the completion status of the conversation.
  module LifecycleState
    # Unknown.
    LIFECYCLE_STATE_UNSPECIFIED = 0

    # Conversation is currently open for media analysis.
    IN_PROGRESS = 1

    # Conversation has been completed.
    COMPLETED = 2
  end

  # Enumeration of the different conversation stages a conversation can be in.
  # Reference:
  # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
  module ConversationStage
    # Unknown. Should never be used after a conversation is successfully
    # created.
    CONVERSATION_STAGE_UNSPECIFIED = 0

    # The conversation should return virtual agent responses into the
    # conversation.
    VIRTUAL_AGENT_STAGE = 1

    # The conversation should not provide responses, just listen and provide
    # suggestions.
    HUMAN_ASSIST_STAGE = 2
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the conversation was started.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 70

class Conversation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enumeration of the completion status of the conversation.
  module LifecycleState
    # Unknown.
    LIFECYCLE_STATE_UNSPECIFIED = 0

    # Conversation is currently open for media analysis.
    IN_PROGRESS = 1

    # Conversation has been completed.
    COMPLETED = 2
  end

  # Enumeration of the different conversation stages a conversation can be in.
  # Reference:
  # https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
  module ConversationStage
    # Unknown. Should never be used after a conversation is successfully
    # created.
    CONVERSATION_STAGE_UNSPECIFIED = 0

    # The conversation should return virtual agent responses into the
    # conversation.
    VIRTUAL_AGENT_STAGE = 1

    # The conversation should not provide responses, just listen and provide
    # suggestions.
    HUMAN_ASSIST_STAGE = 2
  end
end