Class: Google::Cloud::Dialogflow::V2::ConversationEvent

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/conversation_event.rb

Overview

Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Attribute Details

#conversation ⇒ ::String

Returns The unique identifier of the conversation this notification refers to. Format: projects/<Project ID>/conversations/<Conversation ID>.

Returns:

  • (::String) —

    The unique identifier of the conversation this notification refers to. Format: projects/<Project ID>/conversations/<Conversation ID>.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_event.rb', line 41

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

  # Enumeration of the types of events available.
  module Type
    # Type not set.
    TYPE_UNSPECIFIED = 0

    # A new conversation has been opened. This is fired when a telephone call
    # is answered, or a conversation is created via the API.
    CONVERSATION_STARTED = 1

    # An existing conversation has closed. This is fired when a telephone call
    # is terminated, or a conversation is closed via the API.
    CONVERSATION_FINISHED = 2

    # An existing conversation has received notification from Dialogflow that
    # human intervention is required.
    HUMAN_INTERVENTION_NEEDED = 3

    # An existing conversation has received a new message, either from API or
    # telephony. It is configured in
    # {::Google::Cloud::Dialogflow::V2::ConversationProfile#new_message_event_notification_config ConversationProfile.new_message_event_notification_config}
    NEW_MESSAGE = 5

    # Unrecoverable error during a telephone call.
    #
    # In general non-recoverable errors only occur if something was
    # misconfigured in the ConversationProfile corresponding to the call. After
    # a non-recoverable error, Dialogflow may stop responding.
    #
    # We don't fire this event:
    #
    # * in an API call because we can directly return the error, or,
    # * when we can recover from an error.
    UNRECOVERABLE_ERROR = 4
  end
end

#error_status ⇒ ::Google::Rpc::Status

Returns More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.

Returns:

  • (::Google::Rpc::Status) —

    More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_event.rb', line 41

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

  # Enumeration of the types of events available.
  module Type
    # Type not set.
    TYPE_UNSPECIFIED = 0

    # A new conversation has been opened. This is fired when a telephone call
    # is answered, or a conversation is created via the API.
    CONVERSATION_STARTED = 1

    # An existing conversation has closed. This is fired when a telephone call
    # is terminated, or a conversation is closed via the API.
    CONVERSATION_FINISHED = 2

    # An existing conversation has received notification from Dialogflow that
    # human intervention is required.
    HUMAN_INTERVENTION_NEEDED = 3

    # An existing conversation has received a new message, either from API or
    # telephony. It is configured in
    # {::Google::Cloud::Dialogflow::V2::ConversationProfile#new_message_event_notification_config ConversationProfile.new_message_event_notification_config}
    NEW_MESSAGE = 5

    # Unrecoverable error during a telephone call.
    #
    # In general non-recoverable errors only occur if something was
    # misconfigured in the ConversationProfile corresponding to the call. After
    # a non-recoverable error, Dialogflow may stop responding.
    #
    # We don't fire this event:
    #
    # * in an API call because we can directly return the error, or,
    # * when we can recover from an error.
    UNRECOVERABLE_ERROR = 4
  end
end

#new_message_payload ⇒ ::Google::Cloud::Dialogflow::V2::Message

Returns Payload of NEW_MESSAGE event.

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_event.rb', line 41

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

  # Enumeration of the types of events available.
  module Type
    # Type not set.
    TYPE_UNSPECIFIED = 0

    # A new conversation has been opened. This is fired when a telephone call
    # is answered, or a conversation is created via the API.
    CONVERSATION_STARTED = 1

    # An existing conversation has closed. This is fired when a telephone call
    # is terminated, or a conversation is closed via the API.
    CONVERSATION_FINISHED = 2

    # An existing conversation has received notification from Dialogflow that
    # human intervention is required.
    HUMAN_INTERVENTION_NEEDED = 3

    # An existing conversation has received a new message, either from API or
    # telephony. It is configured in
    # {::Google::Cloud::Dialogflow::V2::ConversationProfile#new_message_event_notification_config ConversationProfile.new_message_event_notification_config}
    NEW_MESSAGE = 5

    # Unrecoverable error during a telephone call.
    #
    # In general non-recoverable errors only occur if something was
    # misconfigured in the ConversationProfile corresponding to the call. After
    # a non-recoverable error, Dialogflow may stop responding.
    #
    # We don't fire this event:
    #
    # * in an API call because we can directly return the error, or,
    # * when we can recover from an error.
    UNRECOVERABLE_ERROR = 4
  end
end

#type ⇒ ::Google::Cloud::Dialogflow::V2::ConversationEvent::Type

Returns The type of the event that this notification refers to.

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation_event.rb', line 41

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

  # Enumeration of the types of events available.
  module Type
    # Type not set.
    TYPE_UNSPECIFIED = 0

    # A new conversation has been opened. This is fired when a telephone call
    # is answered, or a conversation is created via the API.
    CONVERSATION_STARTED = 1

    # An existing conversation has closed. This is fired when a telephone call
    # is terminated, or a conversation is closed via the API.
    CONVERSATION_FINISHED = 2

    # An existing conversation has received notification from Dialogflow that
    # human intervention is required.
    HUMAN_INTERVENTION_NEEDED = 3

    # An existing conversation has received a new message, either from API or
    # telephony. It is configured in
    # {::Google::Cloud::Dialogflow::V2::ConversationProfile#new_message_event_notification_config ConversationProfile.new_message_event_notification_config}
    NEW_MESSAGE = 5

    # Unrecoverable error during a telephone call.
    #
    # In general non-recoverable errors only occur if something was
    # misconfigured in the ConversationProfile corresponding to the call. After
    # a non-recoverable error, Dialogflow may stop responding.
    #
    # We don't fire this event:
    #
    # * in an API call because we can directly return the error, or,
    # * when we can recover from an error.
    UNRECOVERABLE_ERROR = 4
  end
end