Class: Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1Conversation

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

Overview

The conversation resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudContactcenterinsightsV1alpha1Conversation

Returns a new instance of GoogleCloudContactcenterinsightsV1alpha1Conversation.



12685
12686
12687
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12685

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

Instance Attribute Details

#agent_id ⇒ String

An opaque, user-specified string representing the human agent who handled the conversation. Corresponds to the JSON property agentId

Returns:

  • (String) 


12564
12565
12566
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12564

def agent_id
  @agent_id
end

#call_metadata ⇒ Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata

Call-specific metadata. Corresponds to the JSON property callMetadata

Returns:



12569
12570
12571
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12569

def call_metadata
  @call_metadata
end

#correlation_info ⇒ Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1ConversationCorrelationInfo

Info for correlating across conversations. Corresponds to the JSON property correlationInfo

Returns:



12574
12575
12576
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12574

def correlation_info
  @correlation_info
end

#create_time ⇒ String

Output only. The time at which the conversation was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


12579
12580
12581
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12579

def create_time
  @create_time
end

#data_source ⇒ Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource

The conversation source, which is a combination of transcript and audio. Corresponds to the JSON property dataSource

Returns:



12584
12585
12586
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12584

def data_source
  @data_source
end

#dialogflow_intents ⇒ Hash<String,Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent>

Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/project/agent/agent/ intents/intent Corresponds to the JSON property dialogflowIntents

Returns:



12591
12592
12593
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12591

def dialogflow_intents
  @dialogflow_intents
end

#duration ⇒ String

Output only. The duration of the conversation. Corresponds to the JSON property duration

Returns:

  • (String) 


12596
12597
12598
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12596

def duration
  @duration
end

#expire_time ⇒ String

The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. Corresponds to the JSON property expireTime

Returns:

  • (String) 


12602
12603
12604
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12602

def expire_time
  @expire_time
end

#labels ⇒ Hash<String,String>

A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


12608
12609
12610
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12608

def labels
  @labels
end

#language_code ⇒ String

A user-specified language code for the conversation. Corresponds to the JSON property languageCode

Returns:

  • (String) 


12613
12614
12615
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12613

def language_code
  @language_code
end

#latest_analysis ⇒ Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1Analysis

The analysis resource. Corresponds to the JSON property latestAnalysis

Returns:



12618
12619
12620
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12618

def latest_analysis
  @latest_analysis
end

#latest_summary ⇒ Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData

Conversation summarization suggestion data. Corresponds to the JSON property latestSummary

Returns:



12623
12624
12625
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12623

def latest_summary
  @latest_summary
end

#medium ⇒ String

Immutable. The conversation medium. Corresponds to the JSON property medium

Returns:

  • (String) 


12628
12629
12630
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12628

def medium
  @medium
end

#metadata_json ⇒ String

Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats. Corresponds to the JSON property metadataJson

Returns:

  • (String) 


12635
12636
12637
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12635

def metadata_json
  @metadata_json
end

#name ⇒ String

Immutable. The resource name of the conversation. Format: projects/project/ locations/location/conversations/conversation Corresponds to the JSON property name

Returns:

  • (String) 


12641
12642
12643
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12641

def name
  @name
end

#obfuscated_user_id ⇒ String

Obfuscated user ID which the customer sent to us. Corresponds to the JSON property obfuscatedUserId

Returns:

  • (String) 


12646
12647
12648
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12646

def obfuscated_user_id
  @obfuscated_user_id
end

#quality_metadata ⇒ Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata

Conversation metadata related to quality management. Corresponds to the JSON property qualityMetadata

Returns:



12651
12652
12653
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12651

def quality_metadata
  @quality_metadata
end

#runtime_annotations ⇒ Array<Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation>

Output only. The annotations that were generated during the customer and agent interaction. Corresponds to the JSON property runtimeAnnotations

Returns:



12657
12658
12659
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12657

def runtime_annotations
  @runtime_annotations
end

#start_time ⇒ String

The time at which the conversation started. Corresponds to the JSON property startTime

Returns:

  • (String) 


12662
12663
12664
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12662

def start_time
  @start_time
end

#transcript ⇒ Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript

A message representing the transcript of a conversation. Corresponds to the JSON property transcript

Returns:



12667
12668
12669
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12667

def transcript
  @transcript
end

#ttl ⇒ String

Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. Corresponds to the JSON property ttl

Returns:

  • (String) 


12673
12674
12675
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12673

def ttl
  @ttl
end

#turn_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


12678
12679
12680
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12678

def turn_count
  @turn_count
end

#update_time ⇒ String

Output only. The most recent time at which the conversation was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


12683
12684
12685
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12683

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 12690

def update!(**args)
  @agent_id = args[:agent_id] if args.key?(:agent_id)
  @call_metadata = args[:call_metadata] if args.key?(:call_metadata)
  @correlation_info = args[:correlation_info] if args.key?(:correlation_info)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_source = args[:data_source] if args.key?(:data_source)
  @dialogflow_intents = args[:dialogflow_intents] if args.key?(:dialogflow_intents)
  @duration = args[:duration] if args.key?(:duration)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @labels = args[:labels] if args.key?(:labels)
  @language_code = args[:language_code] if args.key?(:language_code)
  @latest_analysis = args[:latest_analysis] if args.key?(:latest_analysis)
  @latest_summary = args[:latest_summary] if args.key?(:latest_summary)
  @medium = args[:medium] if args.key?(:medium)
  @metadata_json = args[:metadata_json] if args.key?(:metadata_json)
  @name = args[:name] if args.key?(:name)
  @obfuscated_user_id = args[:obfuscated_user_id] if args.key?(:obfuscated_user_id)
  @quality_metadata = args[:quality_metadata] if args.key?(:quality_metadata)
  @runtime_annotations = args[:runtime_annotations] if args.key?(:runtime_annotations)
  @start_time = args[:start_time] if args.key?(:start_time)
  @transcript = args[:transcript] if args.key?(:transcript)
  @ttl = args[:ttl] if args.key?(:ttl)
  @turn_count = args[:turn_count] if args.key?(:turn_count)
  @update_time = args[:update_time] if args.key?(:update_time)
end