Class: Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1Entity

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 data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudContactcenterinsightsV1alpha1Entity

Returns a new instance of GoogleCloudContactcenterinsightsV1alpha1Entity.



5479
5480
5481
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 5479

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

Instance Attribute Details

#display_name ⇒ String

The representative name for the entity. Corresponds to the JSON property displayName

Returns:

  • (String) 


5451
5452
5453
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 5451

def display_name
  @display_name
end

#metadata ⇒ Hash<String,String>

Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (wikipedia_url) and Knowledge Graph MID (mid), if they are available. For the metadata associated with other entity types, see the Type table below. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,String>) 


5459
5460
5461
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 5459

def metadata
  @metadata
end

#salience ⇒ Float

The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. Corresponds to the JSON property salience

Returns:

  • (Float) 


5467
5468
5469
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 5467

def salience
  @salience
end

#sentiment ⇒ Google::Apis::ContactcenterinsightsV1::GoogleCloudContactcenterinsightsV1alpha1SentimentData

The data for a sentiment annotation. Corresponds to the JSON property sentiment

Returns:



5472
5473
5474
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 5472

def sentiment
  @sentiment
end

#type ⇒ String

The entity type. Corresponds to the JSON property type

Returns:

  • (String) 


5477
5478
5479
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 5477

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5484
5485
5486
5487
5488
5489
5490
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 5484

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @metadata = args[:metadata] if args.key?(:metadata)
  @salience = args[:salience] if args.key?(:salience)
  @sentiment = args[:sentiment] if args.key?(:sentiment)
  @type = args[:type] if args.key?(:type)
end