Contact Center AI Insights V1 API - Class Google::Cloud::ContactCenterInsights::V1::Entity (v0.12.0)

Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::Entity.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#display_name

def display_name() -> ::String
Returns
  • (::String) — The representative name for the entity.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The representative name for the entity.
Returns
  • (::String) — The representative name for the entity.

#metadata

def metadata() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::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.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::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.

Returns
  • (::Google::Protobuf::Map{::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.

#salience

def salience() -> ::Float
Returns
  • (::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.

#salience=

def salience=(value) -> ::Float
Parameter
  • value (::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.

Returns
  • (::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.

#sentiment

def sentiment() -> ::Google::Cloud::ContactCenterInsights::V1::SentimentData
Returns

#sentiment=

def sentiment=(value) -> ::Google::Cloud::ContactCenterInsights::V1::SentimentData
Parameter
Returns

#type

def type() -> ::Google::Cloud::ContactCenterInsights::V1::Entity::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::ContactCenterInsights::V1::Entity::Type
Parameter
Returns