Class: Google::Apis::CesV1::Conversation

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/ces_v1/classes.rb,
lib/google/apis/ces_v1/representations.rb,
lib/google/apis/ces_v1/representations.rb

Overview

A conversation represents an interaction between an end user and the CES app.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Conversation

Returns a new instance of Conversation.



2108
2109
2110
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2108

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#app_version ⇒ String

Output only. The version of the app used for processing the conversation. Format: projects/project/locations/location/apps/app/versions/version` Corresponds to the JSON propertyappVersion`

Returns:

  • (String) 


2041
2042
2043
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2041

def app_version
  @app_version
end

#channel_type ⇒ String

DEPRECATED. Please use input_types instead. Corresponds to the JSON property channelType

Returns:

  • (String) 


2046
2047
2048
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2046

def channel_type
  @channel_type
end

#deployment ⇒ String

Output only. The deployment of the app used for processing the conversation. Format: projects/project/locations/location/apps/app/deployments/ deployment` Corresponds to the JSON propertydeployment`

Returns:

  • (String) 


2053
2054
2055
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2053

def deployment
  @deployment
end

#end_time ⇒ String

Output only. Timestamp when the conversation was completed. Corresponds to the JSON property endTime

Returns:

  • (String) 


2058
2059
2060
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2058

def end_time
  @end_time
end

#entry_agent ⇒ 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` Corresponds to the JSON propertyentryAgent`

Returns:

  • (String) 


2065
2066
2067
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2065

def entry_agent
  @entry_agent
end

#input_types ⇒ Array<String>

Output only. The input types of the conversation. Corresponds to the JSON property inputTypes

Returns:

  • (Array<String>) 


2070
2071
2072
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2070

def input_types
  @input_types
end

#language_code ⇒ String

Output only. The language code of the conversation. Corresponds to the JSON property languageCode

Returns:

  • (String) 


2075
2076
2077
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2075

def language_code
  @language_code
end

#messages ⇒ Array<Google::Apis::CesV1::Message>

Deprecated. Use turns instead. Corresponds to the JSON property messages

Returns:



2080
2081
2082
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2080

def messages
  @messages
end

#name ⇒ String

Identifier. The unique identifier of the conversation. Format: projects/ project/locations/location/apps/app/conversations/conversation` Corresponds to the JSON propertyname`

Returns:

  • (String) 


2086
2087
2088
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2086

def name
  @name
end

#source ⇒ String

Output only. Indicate the source of the conversation. Corresponds to the JSON property source

Returns:

  • (String) 


2091
2092
2093
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2091

def source
  @source
end

#start_time ⇒ String

Output only. Timestamp when the conversation was created. Corresponds to the JSON property startTime

Returns:

  • (String) 


2096
2097
2098
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2096

def start_time
  @start_time
end

#turn_count ⇒ Fixnum

Output only. The number of turns in the conversation. Corresponds to the JSON property turnCount

Returns:

  • (Fixnum) 


2101
2102
2103
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2101

def turn_count
  @turn_count
end

#turns ⇒ Array<Google::Apis::CesV1::ConversationTurn>

Required. The turns in the conversation. Corresponds to the JSON property turns

Returns:



2106
2107
2108
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2106

def turns
  @turns
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
 
# File 'lib/google/apis/ces_v1/classes.rb', line 2113

def update!(**args)
  @app_version = args[:app_version] if args.key?(:app_version)
  @channel_type = args[:channel_type] if args.key?(:channel_type)
  @deployment = args[:deployment] if args.key?(:deployment)
  @end_time = args[:end_time] if args.key?(:end_time)
  @entry_agent = args[:entry_agent] if args.key?(:entry_agent)
  @input_types = args[:input_types] if args.key?(:input_types)
  @language_code = args[:language_code] if args.key?(:language_code)
  @messages = args[:messages] if args.key?(:messages)
  @name = args[:name] if args.key?(:name)
  @source = args[:source] if args.key?(:source)
  @start_time = args[:start_time] if args.key?(:start_time)
  @turn_count = args[:turn_count] if args.key?(:turn_count)
  @turns = args[:turns] if args.key?(:turns)
end