Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1 API class Google::Cloud::Ces::V1::Conversation.
A conversation represents an interaction between an end user and the CES app.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#app_version
def app_version() -> ::String
Returns
-
(::String) — Output only. The version of the app used for processing the conversation.
Format:
projects/{project}/locations/{location}/apps/{app}/versions/{version}
#channel_type
def channel_type() -> ::Google::Cloud::Ces::V1::Conversation::ChannelType
Returns
- (::Google::Cloud::Ces::V1::Conversation::ChannelType) — DEPRECATED. Please use input_types instead.
#channel_type=
def channel_type=(value) -> ::Google::Cloud::Ces::V1::Conversation::ChannelType
Parameter
- value (::Google::Cloud::Ces::V1::Conversation::ChannelType) — DEPRECATED. Please use input_types instead.
Returns
- (::Google::Cloud::Ces::V1::Conversation::ChannelType) — DEPRECATED. Please use input_types instead.
#deployment
def deployment() -> ::String
Returns
-
(::String) — Output only. The deployment of the app used for processing the
conversation. Format:
projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when the conversation was completed.
#entry_agent
def entry_agent() -> ::String
Returns
-
(::String) — Output only. The agent that initially handles the conversation. If not
specified, the conversation is handled by the root agent. Format:
projects/{project}/locations/{location}/apps/{app}/agents/{agent}
#input_types
def input_types() -> ::Array<::Google::Cloud::Ces::V1::Conversation::InputType>
Returns
- (::Array<::Google::Cloud::Ces::V1::Conversation::InputType>) — Output only. The input types of the conversation.
#language_code
def language_code() -> ::String
Returns
- (::String) — Output only. The language code of the conversation.
#messages
def messages() -> ::Array<::Google::Cloud::Ces::V1::Message>
Returns
- (::Array<::Google::Cloud::Ces::V1::Message>) — Deprecated. Use turns instead.
#messages=
def messages=(value) -> ::Array<::Google::Cloud::Ces::V1::Message>
Parameter
- value (::Array<::Google::Cloud::Ces::V1::Message>) — Deprecated. Use turns instead.
Returns
- (::Array<::Google::Cloud::Ces::V1::Message>) — Deprecated. Use turns instead.
#name
def name() -> ::String
Returns
-
(::String) — Identifier. The unique identifier of the conversation.
Format:
projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Identifier. The unique identifier of the conversation.
Format:
projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
Returns
-
(::String) — Identifier. The unique identifier of the conversation.
Format:
projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
#source
def source() -> ::Google::Cloud::Ces::V1::Conversation::Source
Returns
- (::Google::Cloud::Ces::V1::Conversation::Source) — Output only. Indicate the source of the conversation.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when the conversation was created.
#turn_count
def turn_count() -> ::Integer
Returns
- (::Integer) — Output only. The number of turns in the conversation.
#turns
def turns() -> ::Array<::Google::Cloud::Ces::V1::Conversation::Turn>
Returns
- (::Array<::Google::Cloud::Ces::V1::Conversation::Turn>) — Required. The turns in the conversation.
#turns=
def turns=(value) -> ::Array<::Google::Cloud::Ces::V1::Conversation::Turn>
Parameter
- value (::Array<::Google::Cloud::Ces::V1::Conversation::Turn>) — Required. The turns in the conversation.
Returns
- (::Array<::Google::Cloud::Ces::V1::Conversation::Turn>) — Required. The turns in the conversation.