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 Classes: ContextReference, IngestedContextReferencesEntry, TelephonyConnectionInfo

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



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 76

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

  # The information about phone calls connected via phone gateway to the
  # conversation.
  # @!attribute [r] dialed_number
  #   @return [::String]
  #     Output only. The number dialed to connect this call in E.164 format.
  # @!attribute [rw] sdp
  #   @return [::String]
  #     Optional. SDP of the call. It's initially the SDP answer to the endpoint,
  #     but maybe later updated for the purpose of making the link active, etc.
  # @!attribute [r] sip_headers
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
  #     Output only. The SIP headers from the initial SIP INVITE.
  # @!attribute [r] extra_mime_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::MimeContent>]
  #     Output only. The mime content from the initial SIP INVITE.
  class TelephonyConnectionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The SIP headers from the initial SIP INVITE.
    # @!attribute [rw] name
    #   @return [::String]
    #     Optional. The name of the header.
    # @!attribute [rw] value
    #   @return [::String]
    #     Optional. The value of the header.
    class SipHeader
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The mime content from the initial SIP INVITE.
    # @!attribute [rw] mime_type
    #   @return [::String]
    #     Optional. The mime type of the content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Optional. The content payload.
    class MimeContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents a section of ingested context information.
  # @!attribute [rw] context_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>]
  #     Required. The list of content updates for a context reference.
  # @!attribute [rw] update_mode
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode]
  #     Required. The mode in which context reference contents are updated.
  # @!attribute [rw] language_code
  #   @return [::String]
  #     Optional. The language of the information ingested, defaults to "en-US"
  #     if not set.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time the context reference was first created.
  class ContextReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contents ingested.
    # @!attribute [rw] content
    #   @return [::String]
    #     Required. The information ingested in a single request.
    # @!attribute [rw] content_format
    #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
    #     Required. The format of the ingested string.
    # @!attribute [r] ingestion_time
    #   @return [::Google::Protobuf::Timestamp]
    #     Output only. The time when this information was incorporated into the
    #     relevant context reference.
    class ContextContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the format of the ingested string.
      module ContentFormat
        # Unspecified content format.
        CONTENT_FORMAT_UNSPECIFIED = 0

        # Content was provided in JSON format.
        JSON = 1

        # Content was provided as plain text.
        PLAIN_TEXT = 2
      end
    end

    # Represents the mode in which context reference contents are updated.
    module UpdateMode
      # Unspecified update mode.
      UPDATE_MODE_UNSPECIFIED = 0

      # Context content updates are applied in append mode.
      APPEND = 1

      # Context content updates are applied in overwrite mode.
      OVERWRITE = 2
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
  class IngestedContextReferencesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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/agent-assist/docs/basics#conversation_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:



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 76

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

  # The information about phone calls connected via phone gateway to the
  # conversation.
  # @!attribute [r] dialed_number
  #   @return [::String]
  #     Output only. The number dialed to connect this call in E.164 format.
  # @!attribute [rw] sdp
  #   @return [::String]
  #     Optional. SDP of the call. It's initially the SDP answer to the endpoint,
  #     but maybe later updated for the purpose of making the link active, etc.
  # @!attribute [r] sip_headers
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
  #     Output only. The SIP headers from the initial SIP INVITE.
  # @!attribute [r] extra_mime_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::MimeContent>]
  #     Output only. The mime content from the initial SIP INVITE.
  class TelephonyConnectionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The SIP headers from the initial SIP INVITE.
    # @!attribute [rw] name
    #   @return [::String]
    #     Optional. The name of the header.
    # @!attribute [rw] value
    #   @return [::String]
    #     Optional. The value of the header.
    class SipHeader
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The mime content from the initial SIP INVITE.
    # @!attribute [rw] mime_type
    #   @return [::String]
    #     Optional. The mime type of the content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Optional. The content payload.
    class MimeContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents a section of ingested context information.
  # @!attribute [rw] context_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>]
  #     Required. The list of content updates for a context reference.
  # @!attribute [rw] update_mode
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode]
  #     Required. The mode in which context reference contents are updated.
  # @!attribute [rw] language_code
  #   @return [::String]
  #     Optional. The language of the information ingested, defaults to "en-US"
  #     if not set.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time the context reference was first created.
  class ContextReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contents ingested.
    # @!attribute [rw] content
    #   @return [::String]
    #     Required. The information ingested in a single request.
    # @!attribute [rw] content_format
    #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
    #     Required. The format of the ingested string.
    # @!attribute [r] ingestion_time
    #   @return [::Google::Protobuf::Timestamp]
    #     Output only. The time when this information was incorporated into the
    #     relevant context reference.
    class ContextContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the format of the ingested string.
      module ContentFormat
        # Unspecified content format.
        CONTENT_FORMAT_UNSPECIFIED = 0

        # Content was provided in JSON format.
        JSON = 1

        # Content was provided as plain text.
        PLAIN_TEXT = 2
      end
    end

    # Represents the mode in which context reference contents are updated.
    module UpdateMode
      # Unspecified update mode.
      UPDATE_MODE_UNSPECIFIED = 0

      # Context content updates are applied in append mode.
      APPEND = 1

      # Context content updates are applied in overwrite mode.
      OVERWRITE = 2
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
  class IngestedContextReferencesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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/agent-assist/docs/basics#conversation_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:



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 76

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

  # The information about phone calls connected via phone gateway to the
  # conversation.
  # @!attribute [r] dialed_number
  #   @return [::String]
  #     Output only. The number dialed to connect this call in E.164 format.
  # @!attribute [rw] sdp
  #   @return [::String]
  #     Optional. SDP of the call. It's initially the SDP answer to the endpoint,
  #     but maybe later updated for the purpose of making the link active, etc.
  # @!attribute [r] sip_headers
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
  #     Output only. The SIP headers from the initial SIP INVITE.
  # @!attribute [r] extra_mime_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::MimeContent>]
  #     Output only. The mime content from the initial SIP INVITE.
  class TelephonyConnectionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The SIP headers from the initial SIP INVITE.
    # @!attribute [rw] name
    #   @return [::String]
    #     Optional. The name of the header.
    # @!attribute [rw] value
    #   @return [::String]
    #     Optional. The value of the header.
    class SipHeader
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The mime content from the initial SIP INVITE.
    # @!attribute [rw] mime_type
    #   @return [::String]
    #     Optional. The mime type of the content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Optional. The content payload.
    class MimeContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents a section of ingested context information.
  # @!attribute [rw] context_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>]
  #     Required. The list of content updates for a context reference.
  # @!attribute [rw] update_mode
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode]
  #     Required. The mode in which context reference contents are updated.
  # @!attribute [rw] language_code
  #   @return [::String]
  #     Optional. The language of the information ingested, defaults to "en-US"
  #     if not set.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time the context reference was first created.
  class ContextReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contents ingested.
    # @!attribute [rw] content
    #   @return [::String]
    #     Required. The information ingested in a single request.
    # @!attribute [rw] content_format
    #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
    #     Required. The format of the ingested string.
    # @!attribute [r] ingestion_time
    #   @return [::Google::Protobuf::Timestamp]
    #     Output only. The time when this information was incorporated into the
    #     relevant context reference.
    class ContextContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the format of the ingested string.
      module ContentFormat
        # Unspecified content format.
        CONTENT_FORMAT_UNSPECIFIED = 0

        # Content was provided in JSON format.
        JSON = 1

        # Content was provided as plain text.
        PLAIN_TEXT = 2
      end
    end

    # Represents the mode in which context reference contents are updated.
    module UpdateMode
      # Unspecified update mode.
      UPDATE_MODE_UNSPECIFIED = 0

      # Context content updates are applied in append mode.
      APPEND = 1

      # Context content updates are applied in overwrite mode.
      OVERWRITE = 2
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
  class IngestedContextReferencesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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/agent-assist/docs/basics#conversation_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

#ingested_context_references::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::V2::Conversation::ContextReference} (readonly)

Returns Output only. The context reference updates provided by external systems.

Returns:



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 76

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

  # The information about phone calls connected via phone gateway to the
  # conversation.
  # @!attribute [r] dialed_number
  #   @return [::String]
  #     Output only. The number dialed to connect this call in E.164 format.
  # @!attribute [rw] sdp
  #   @return [::String]
  #     Optional. SDP of the call. It's initially the SDP answer to the endpoint,
  #     but maybe later updated for the purpose of making the link active, etc.
  # @!attribute [r] sip_headers
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
  #     Output only. The SIP headers from the initial SIP INVITE.
  # @!attribute [r] extra_mime_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::MimeContent>]
  #     Output only. The mime content from the initial SIP INVITE.
  class TelephonyConnectionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The SIP headers from the initial SIP INVITE.
    # @!attribute [rw] name
    #   @return [::String]
    #     Optional. The name of the header.
    # @!attribute [rw] value
    #   @return [::String]
    #     Optional. The value of the header.
    class SipHeader
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The mime content from the initial SIP INVITE.
    # @!attribute [rw] mime_type
    #   @return [::String]
    #     Optional. The mime type of the content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Optional. The content payload.
    class MimeContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents a section of ingested context information.
  # @!attribute [rw] context_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>]
  #     Required. The list of content updates for a context reference.
  # @!attribute [rw] update_mode
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode]
  #     Required. The mode in which context reference contents are updated.
  # @!attribute [rw] language_code
  #   @return [::String]
  #     Optional. The language of the information ingested, defaults to "en-US"
  #     if not set.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time the context reference was first created.
  class ContextReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contents ingested.
    # @!attribute [rw] content
    #   @return [::String]
    #     Required. The information ingested in a single request.
    # @!attribute [rw] content_format
    #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
    #     Required. The format of the ingested string.
    # @!attribute [r] ingestion_time
    #   @return [::Google::Protobuf::Timestamp]
    #     Output only. The time when this information was incorporated into the
    #     relevant context reference.
    class ContextContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the format of the ingested string.
      module ContentFormat
        # Unspecified content format.
        CONTENT_FORMAT_UNSPECIFIED = 0

        # Content was provided in JSON format.
        JSON = 1

        # Content was provided as plain text.
        PLAIN_TEXT = 2
      end
    end

    # Represents the mode in which context reference contents are updated.
    module UpdateMode
      # Unspecified update mode.
      UPDATE_MODE_UNSPECIFIED = 0

      # Context content updates are applied in append mode.
      APPEND = 1

      # Context content updates are applied in overwrite mode.
      OVERWRITE = 2
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
  class IngestedContextReferencesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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/agent-assist/docs/basics#conversation_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:



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 76

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

  # The information about phone calls connected via phone gateway to the
  # conversation.
  # @!attribute [r] dialed_number
  #   @return [::String]
  #     Output only. The number dialed to connect this call in E.164 format.
  # @!attribute [rw] sdp
  #   @return [::String]
  #     Optional. SDP of the call. It's initially the SDP answer to the endpoint,
  #     but maybe later updated for the purpose of making the link active, etc.
  # @!attribute [r] sip_headers
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
  #     Output only. The SIP headers from the initial SIP INVITE.
  # @!attribute [r] extra_mime_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::MimeContent>]
  #     Output only. The mime content from the initial SIP INVITE.
  class TelephonyConnectionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The SIP headers from the initial SIP INVITE.
    # @!attribute [rw] name
    #   @return [::String]
    #     Optional. The name of the header.
    # @!attribute [rw] value
    #   @return [::String]
    #     Optional. The value of the header.
    class SipHeader
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The mime content from the initial SIP INVITE.
    # @!attribute [rw] mime_type
    #   @return [::String]
    #     Optional. The mime type of the content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Optional. The content payload.
    class MimeContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents a section of ingested context information.
  # @!attribute [rw] context_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>]
  #     Required. The list of content updates for a context reference.
  # @!attribute [rw] update_mode
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode]
  #     Required. The mode in which context reference contents are updated.
  # @!attribute [rw] language_code
  #   @return [::String]
  #     Optional. The language of the information ingested, defaults to "en-US"
  #     if not set.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time the context reference was first created.
  class ContextReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contents ingested.
    # @!attribute [rw] content
    #   @return [::String]
    #     Required. The information ingested in a single request.
    # @!attribute [rw] content_format
    #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
    #     Required. The format of the ingested string.
    # @!attribute [r] ingestion_time
    #   @return [::Google::Protobuf::Timestamp]
    #     Output only. The time when this information was incorporated into the
    #     relevant context reference.
    class ContextContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the format of the ingested string.
      module ContentFormat
        # Unspecified content format.
        CONTENT_FORMAT_UNSPECIFIED = 0

        # Content was provided in JSON format.
        JSON = 1

        # Content was provided as plain text.
        PLAIN_TEXT = 2
      end
    end

    # Represents the mode in which context reference contents are updated.
    module UpdateMode
      # Unspecified update mode.
      UPDATE_MODE_UNSPECIFIED = 0

      # Context content updates are applied in append mode.
      APPEND = 1

      # Context content updates are applied in overwrite mode.
      OVERWRITE = 2
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
  class IngestedContextReferencesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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/agent-assist/docs/basics#conversation_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>.



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 76

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

  # The information about phone calls connected via phone gateway to the
  # conversation.
  # @!attribute [r] dialed_number
  #   @return [::String]
  #     Output only. The number dialed to connect this call in E.164 format.
  # @!attribute [rw] sdp
  #   @return [::String]
  #     Optional. SDP of the call. It's initially the SDP answer to the endpoint,
  #     but maybe later updated for the purpose of making the link active, etc.
  # @!attribute [r] sip_headers
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
  #     Output only. The SIP headers from the initial SIP INVITE.
  # @!attribute [r] extra_mime_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::MimeContent>]
  #     Output only. The mime content from the initial SIP INVITE.
  class TelephonyConnectionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The SIP headers from the initial SIP INVITE.
    # @!attribute [rw] name
    #   @return [::String]
    #     Optional. The name of the header.
    # @!attribute [rw] value
    #   @return [::String]
    #     Optional. The value of the header.
    class SipHeader
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The mime content from the initial SIP INVITE.
    # @!attribute [rw] mime_type
    #   @return [::String]
    #     Optional. The mime type of the content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Optional. The content payload.
    class MimeContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents a section of ingested context information.
  # @!attribute [rw] context_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>]
  #     Required. The list of content updates for a context reference.
  # @!attribute [rw] update_mode
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode]
  #     Required. The mode in which context reference contents are updated.
  # @!attribute [rw] language_code
  #   @return [::String]
  #     Optional. The language of the information ingested, defaults to "en-US"
  #     if not set.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time the context reference was first created.
  class ContextReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contents ingested.
    # @!attribute [rw] content
    #   @return [::String]
    #     Required. The information ingested in a single request.
    # @!attribute [rw] content_format
    #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
    #     Required. The format of the ingested string.
    # @!attribute [r] ingestion_time
    #   @return [::Google::Protobuf::Timestamp]
    #     Output only. The time when this information was incorporated into the
    #     relevant context reference.
    class ContextContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the format of the ingested string.
      module ContentFormat
        # Unspecified content format.
        CONTENT_FORMAT_UNSPECIFIED = 0

        # Content was provided in JSON format.
        JSON = 1

        # Content was provided as plain text.
        PLAIN_TEXT = 2
      end
    end

    # Represents the mode in which context reference contents are updated.
    module UpdateMode
      # Unspecified update mode.
      UPDATE_MODE_UNSPECIFIED = 0

      # Context content updates are applied in append mode.
      APPEND = 1

      # Context content updates are applied in overwrite mode.
      OVERWRITE = 2
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
  class IngestedContextReferencesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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/agent-assist/docs/basics#conversation_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:



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 76

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

  # The information about phone calls connected via phone gateway to the
  # conversation.
  # @!attribute [r] dialed_number
  #   @return [::String]
  #     Output only. The number dialed to connect this call in E.164 format.
  # @!attribute [rw] sdp
  #   @return [::String]
  #     Optional. SDP of the call. It's initially the SDP answer to the endpoint,
  #     but maybe later updated for the purpose of making the link active, etc.
  # @!attribute [r] sip_headers
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
  #     Output only. The SIP headers from the initial SIP INVITE.
  # @!attribute [r] extra_mime_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::MimeContent>]
  #     Output only. The mime content from the initial SIP INVITE.
  class TelephonyConnectionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The SIP headers from the initial SIP INVITE.
    # @!attribute [rw] name
    #   @return [::String]
    #     Optional. The name of the header.
    # @!attribute [rw] value
    #   @return [::String]
    #     Optional. The value of the header.
    class SipHeader
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The mime content from the initial SIP INVITE.
    # @!attribute [rw] mime_type
    #   @return [::String]
    #     Optional. The mime type of the content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Optional. The content payload.
    class MimeContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents a section of ingested context information.
  # @!attribute [rw] context_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>]
  #     Required. The list of content updates for a context reference.
  # @!attribute [rw] update_mode
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode]
  #     Required. The mode in which context reference contents are updated.
  # @!attribute [rw] language_code
  #   @return [::String]
  #     Optional. The language of the information ingested, defaults to "en-US"
  #     if not set.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time the context reference was first created.
  class ContextReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contents ingested.
    # @!attribute [rw] content
    #   @return [::String]
    #     Required. The information ingested in a single request.
    # @!attribute [rw] content_format
    #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
    #     Required. The format of the ingested string.
    # @!attribute [r] ingestion_time
    #   @return [::Google::Protobuf::Timestamp]
    #     Output only. The time when this information was incorporated into the
    #     relevant context reference.
    class ContextContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the format of the ingested string.
      module ContentFormat
        # Unspecified content format.
        CONTENT_FORMAT_UNSPECIFIED = 0

        # Content was provided in JSON format.
        JSON = 1

        # Content was provided as plain text.
        PLAIN_TEXT = 2
      end
    end

    # Represents the mode in which context reference contents are updated.
    module UpdateMode
      # Unspecified update mode.
      UPDATE_MODE_UNSPECIFIED = 0

      # Context content updates are applied in append mode.
      APPEND = 1

      # Context content updates are applied in overwrite mode.
      OVERWRITE = 2
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
  class IngestedContextReferencesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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/agent-assist/docs/basics#conversation_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:



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 76

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

  # The information about phone calls connected via phone gateway to the
  # conversation.
  # @!attribute [r] dialed_number
  #   @return [::String]
  #     Output only. The number dialed to connect this call in E.164 format.
  # @!attribute [rw] sdp
  #   @return [::String]
  #     Optional. SDP of the call. It's initially the SDP answer to the endpoint,
  #     but maybe later updated for the purpose of making the link active, etc.
  # @!attribute [r] sip_headers
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
  #     Output only. The SIP headers from the initial SIP INVITE.
  # @!attribute [r] extra_mime_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::MimeContent>]
  #     Output only. The mime content from the initial SIP INVITE.
  class TelephonyConnectionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The SIP headers from the initial SIP INVITE.
    # @!attribute [rw] name
    #   @return [::String]
    #     Optional. The name of the header.
    # @!attribute [rw] value
    #   @return [::String]
    #     Optional. The value of the header.
    class SipHeader
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The mime content from the initial SIP INVITE.
    # @!attribute [rw] mime_type
    #   @return [::String]
    #     Optional. The mime type of the content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Optional. The content payload.
    class MimeContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents a section of ingested context information.
  # @!attribute [rw] context_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>]
  #     Required. The list of content updates for a context reference.
  # @!attribute [rw] update_mode
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode]
  #     Required. The mode in which context reference contents are updated.
  # @!attribute [rw] language_code
  #   @return [::String]
  #     Optional. The language of the information ingested, defaults to "en-US"
  #     if not set.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time the context reference was first created.
  class ContextReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contents ingested.
    # @!attribute [rw] content
    #   @return [::String]
    #     Required. The information ingested in a single request.
    # @!attribute [rw] content_format
    #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
    #     Required. The format of the ingested string.
    # @!attribute [r] ingestion_time
    #   @return [::Google::Protobuf::Timestamp]
    #     Output only. The time when this information was incorporated into the
    #     relevant context reference.
    class ContextContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the format of the ingested string.
      module ContentFormat
        # Unspecified content format.
        CONTENT_FORMAT_UNSPECIFIED = 0

        # Content was provided in JSON format.
        JSON = 1

        # Content was provided as plain text.
        PLAIN_TEXT = 2
      end
    end

    # Represents the mode in which context reference contents are updated.
    module UpdateMode
      # Unspecified update mode.
      UPDATE_MODE_UNSPECIFIED = 0

      # Context content updates are applied in append mode.
      APPEND = 1

      # Context content updates are applied in overwrite mode.
      OVERWRITE = 2
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
  class IngestedContextReferencesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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/agent-assist/docs/basics#conversation_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

#telephony_connection_info::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo (readonly)

Returns Output only. The telephony connection information.

Returns:



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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 76

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

  # The information about phone calls connected via phone gateway to the
  # conversation.
  # @!attribute [r] dialed_number
  #   @return [::String]
  #     Output only. The number dialed to connect this call in E.164 format.
  # @!attribute [rw] sdp
  #   @return [::String]
  #     Optional. SDP of the call. It's initially the SDP answer to the endpoint,
  #     but maybe later updated for the purpose of making the link active, etc.
  # @!attribute [r] sip_headers
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::SipHeader>]
  #     Output only. The SIP headers from the initial SIP INVITE.
  # @!attribute [r] extra_mime_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::TelephonyConnectionInfo::MimeContent>]
  #     Output only. The mime content from the initial SIP INVITE.
  class TelephonyConnectionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The SIP headers from the initial SIP INVITE.
    # @!attribute [rw] name
    #   @return [::String]
    #     Optional. The name of the header.
    # @!attribute [rw] value
    #   @return [::String]
    #     Optional. The value of the header.
    class SipHeader
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The mime content from the initial SIP INVITE.
    # @!attribute [rw] mime_type
    #   @return [::String]
    #     Optional. The mime type of the content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Optional. The content payload.
    class MimeContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Represents a section of ingested context information.
  # @!attribute [rw] context_contents
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>]
  #     Required. The list of content updates for a context reference.
  # @!attribute [rw] update_mode
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode]
  #     Required. The mode in which context reference contents are updated.
  # @!attribute [rw] language_code
  #   @return [::String]
  #     Optional. The language of the information ingested, defaults to "en-US"
  #     if not set.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time the context reference was first created.
  class ContextReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Contents ingested.
    # @!attribute [rw] content
    #   @return [::String]
    #     Required. The information ingested in a single request.
    # @!attribute [rw] content_format
    #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
    #     Required. The format of the ingested string.
    # @!attribute [r] ingestion_time
    #   @return [::Google::Protobuf::Timestamp]
    #     Output only. The time when this information was incorporated into the
    #     relevant context reference.
    class ContextContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the format of the ingested string.
      module ContentFormat
        # Unspecified content format.
        CONTENT_FORMAT_UNSPECIFIED = 0

        # Content was provided in JSON format.
        JSON = 1

        # Content was provided as plain text.
        PLAIN_TEXT = 2
      end
    end

    # Represents the mode in which context reference contents are updated.
    module UpdateMode
      # Unspecified update mode.
      UPDATE_MODE_UNSPECIFIED = 0

      # Context content updates are applied in append mode.
      APPEND = 1

      # Context content updates are applied in overwrite mode.
      OVERWRITE = 2
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference]
  class IngestedContextReferencesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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/agent-assist/docs/basics#conversation_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