Class: Google::Cloud::ContactCenterInsights::V1::Entity

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/contactcenterinsights/v1/resources.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.

Defined Under Namespace

Modules: Type Classes: MetadataEntry

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ ::String

Returns The representative name for the entity.

Returns:

  • (::String) —

    The representative name for the entity.



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 474

class Entity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the entity. For most entity types, the associated metadata is a
  # Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`). The table
  # below lists the associated fields for entities that have different
  # metadata.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Person.
    PERSON = 1

    # Location.
    LOCATION = 2

    # Organization.
    ORGANIZATION = 3

    # Event.
    EVENT = 4

    # Artwork.
    WORK_OF_ART = 5

    # Consumer product.
    CONSUMER_GOOD = 6

    # Other types of entities.
    OTHER = 7

    # Phone number.
    #
    # The metadata lists the phone number (formatted according to local
    # convention), plus whichever additional elements appear in the text:
    #
    # * `number` - The actual number, broken down into sections according to
    # local convention.
    # * `national_prefix` - Country code, if detected.
    # * `area_code` - Region or area code, if detected.
    # * `extension` - Phone extension (to be dialed after connection), if
    # detected.
    PHONE_NUMBER = 9

    # Address.
    #
    # The metadata identifies the street number and locality plus whichever
    # additional elements appear in the text:
    #
    # * `street_number` - Street number.
    # * `locality` - City or town.
    # * `street_name` - Street/route name, if detected.
    # * `postal_code` - Postal code, if detected.
    # * `country` - Country, if detected.
    # * `broad_region` - Administrative area, such as the state, if detected.
    # * `narrow_region` - Smaller administrative area, such as county, if
    # detected.
    # * `sublocality` - Used in Asian addresses to demark a district within a
    # city, if detected.
    ADDRESS = 10

    # Date.
    #
    # The metadata identifies the components of the date:
    #
    # * `year` - Four digit year, if detected.
    # * `month` - Two digit month number, if detected.
    # * `day` - Two digit day number, if detected.
    DATE = 11

    # Number.
    #
    # The metadata is the number itself.
    NUMBER = 12

    # Price.
    #
    # The metadata identifies the `value` and `currency`.
    PRICE = 13
  end
end

#metadata ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 474

class Entity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the entity. For most entity types, the associated metadata is a
  # Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`). The table
  # below lists the associated fields for entities that have different
  # metadata.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Person.
    PERSON = 1

    # Location.
    LOCATION = 2

    # Organization.
    ORGANIZATION = 3

    # Event.
    EVENT = 4

    # Artwork.
    WORK_OF_ART = 5

    # Consumer product.
    CONSUMER_GOOD = 6

    # Other types of entities.
    OTHER = 7

    # Phone number.
    #
    # The metadata lists the phone number (formatted according to local
    # convention), plus whichever additional elements appear in the text:
    #
    # * `number` - The actual number, broken down into sections according to
    # local convention.
    # * `national_prefix` - Country code, if detected.
    # * `area_code` - Region or area code, if detected.
    # * `extension` - Phone extension (to be dialed after connection), if
    # detected.
    PHONE_NUMBER = 9

    # Address.
    #
    # The metadata identifies the street number and locality plus whichever
    # additional elements appear in the text:
    #
    # * `street_number` - Street number.
    # * `locality` - City or town.
    # * `street_name` - Street/route name, if detected.
    # * `postal_code` - Postal code, if detected.
    # * `country` - Country, if detected.
    # * `broad_region` - Administrative area, such as the state, if detected.
    # * `narrow_region` - Smaller administrative area, such as county, if
    # detected.
    # * `sublocality` - Used in Asian addresses to demark a district within a
    # city, if detected.
    ADDRESS = 10

    # Date.
    #
    # The metadata identifies the components of the date:
    #
    # * `year` - Four digit year, if detected.
    # * `month` - Two digit month number, if detected.
    # * `day` - Two digit day number, if detected.
    DATE = 11

    # Number.
    #
    # The metadata is the number itself.
    NUMBER = 12

    # Price.
    #
    # The metadata identifies the `value` and `currency`.
    PRICE = 13
  end
end

#salience ⇒ ::Float

Returns 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.



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 474

class Entity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the entity. For most entity types, the associated metadata is a
  # Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`). The table
  # below lists the associated fields for entities that have different
  # metadata.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Person.
    PERSON = 1

    # Location.
    LOCATION = 2

    # Organization.
    ORGANIZATION = 3

    # Event.
    EVENT = 4

    # Artwork.
    WORK_OF_ART = 5

    # Consumer product.
    CONSUMER_GOOD = 6

    # Other types of entities.
    OTHER = 7

    # Phone number.
    #
    # The metadata lists the phone number (formatted according to local
    # convention), plus whichever additional elements appear in the text:
    #
    # * `number` - The actual number, broken down into sections according to
    # local convention.
    # * `national_prefix` - Country code, if detected.
    # * `area_code` - Region or area code, if detected.
    # * `extension` - Phone extension (to be dialed after connection), if
    # detected.
    PHONE_NUMBER = 9

    # Address.
    #
    # The metadata identifies the street number and locality plus whichever
    # additional elements appear in the text:
    #
    # * `street_number` - Street number.
    # * `locality` - City or town.
    # * `street_name` - Street/route name, if detected.
    # * `postal_code` - Postal code, if detected.
    # * `country` - Country, if detected.
    # * `broad_region` - Administrative area, such as the state, if detected.
    # * `narrow_region` - Smaller administrative area, such as county, if
    # detected.
    # * `sublocality` - Used in Asian addresses to demark a district within a
    # city, if detected.
    ADDRESS = 10

    # Date.
    #
    # The metadata identifies the components of the date:
    #
    # * `year` - Four digit year, if detected.
    # * `month` - Two digit month number, if detected.
    # * `day` - Two digit day number, if detected.
    DATE = 11

    # Number.
    #
    # The metadata is the number itself.
    NUMBER = 12

    # Price.
    #
    # The metadata identifies the `value` and `currency`.
    PRICE = 13
  end
end

#sentiment ⇒ ::Google::Cloud::ContactCenterInsights::V1::SentimentData

Returns The aggregate sentiment expressed for this entity in the conversation.

Returns:



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 474

class Entity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the entity. For most entity types, the associated metadata is a
  # Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`). The table
  # below lists the associated fields for entities that have different
  # metadata.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Person.
    PERSON = 1

    # Location.
    LOCATION = 2

    # Organization.
    ORGANIZATION = 3

    # Event.
    EVENT = 4

    # Artwork.
    WORK_OF_ART = 5

    # Consumer product.
    CONSUMER_GOOD = 6

    # Other types of entities.
    OTHER = 7

    # Phone number.
    #
    # The metadata lists the phone number (formatted according to local
    # convention), plus whichever additional elements appear in the text:
    #
    # * `number` - The actual number, broken down into sections according to
    # local convention.
    # * `national_prefix` - Country code, if detected.
    # * `area_code` - Region or area code, if detected.
    # * `extension` - Phone extension (to be dialed after connection), if
    # detected.
    PHONE_NUMBER = 9

    # Address.
    #
    # The metadata identifies the street number and locality plus whichever
    # additional elements appear in the text:
    #
    # * `street_number` - Street number.
    # * `locality` - City or town.
    # * `street_name` - Street/route name, if detected.
    # * `postal_code` - Postal code, if detected.
    # * `country` - Country, if detected.
    # * `broad_region` - Administrative area, such as the state, if detected.
    # * `narrow_region` - Smaller administrative area, such as county, if
    # detected.
    # * `sublocality` - Used in Asian addresses to demark a district within a
    # city, if detected.
    ADDRESS = 10

    # Date.
    #
    # The metadata identifies the components of the date:
    #
    # * `year` - Four digit year, if detected.
    # * `month` - Two digit month number, if detected.
    # * `day` - Two digit day number, if detected.
    DATE = 11

    # Number.
    #
    # The metadata is the number itself.
    NUMBER = 12

    # Price.
    #
    # The metadata identifies the `value` and `currency`.
    PRICE = 13
  end
end

#type ⇒ ::Google::Cloud::ContactCenterInsights::V1::Entity::Type

Returns The entity type.

Returns:



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/resources.rb', line 474

class Entity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the entity. For most entity types, the associated metadata is a
  # Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`). The table
  # below lists the associated fields for entities that have different
  # metadata.
  module Type
    # Unspecified.
    TYPE_UNSPECIFIED = 0

    # Person.
    PERSON = 1

    # Location.
    LOCATION = 2

    # Organization.
    ORGANIZATION = 3

    # Event.
    EVENT = 4

    # Artwork.
    WORK_OF_ART = 5

    # Consumer product.
    CONSUMER_GOOD = 6

    # Other types of entities.
    OTHER = 7

    # Phone number.
    #
    # The metadata lists the phone number (formatted according to local
    # convention), plus whichever additional elements appear in the text:
    #
    # * `number` - The actual number, broken down into sections according to
    # local convention.
    # * `national_prefix` - Country code, if detected.
    # * `area_code` - Region or area code, if detected.
    # * `extension` - Phone extension (to be dialed after connection), if
    # detected.
    PHONE_NUMBER = 9

    # Address.
    #
    # The metadata identifies the street number and locality plus whichever
    # additional elements appear in the text:
    #
    # * `street_number` - Street number.
    # * `locality` - City or town.
    # * `street_name` - Street/route name, if detected.
    # * `postal_code` - Postal code, if detected.
    # * `country` - Country, if detected.
    # * `broad_region` - Administrative area, such as the state, if detected.
    # * `narrow_region` - Smaller administrative area, such as county, if
    # detected.
    # * `sublocality` - Used in Asian addresses to demark a district within a
    # city, if detected.
    ADDRESS = 10

    # Date.
    #
    # The metadata identifies the components of the date:
    #
    # * `year` - Four digit year, if detected.
    # * `month` - Two digit month number, if detected.
    # * `day` - Two digit day number, if detected.
    DATE = 11

    # Number.
    #
    # The metadata is the number itself.
    NUMBER = 12

    # Price.
    #
    # The metadata identifies the `value` and `currency`.
    PRICE = 13
  end
end