Natural Language V1 API - Module Google::Cloud::Language::V1::Entity::Type (v0.4.5)

Reference documentation and code samples for the Natural Language V1 API module Google::Cloud::Language::V1::Entity::Type.

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.

Constants

UNKNOWN

value: 0
Unknown

PERSON

value: 1
Person

LOCATION

value: 2
Location

ORGANIZATION

value: 3
Organization

EVENT

value: 4
Event

WORK_OF_ART

value: 5
Artwork

CONSUMER_GOOD

value: 6
Consumer product

OTHER

value: 7
Other types of entities

PHONE_NUMBER

value: 9
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 as per 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

ADDRESS

value: 10
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

DATE

value: 11
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

NUMBER

value: 12
Number

The metadata is the number itself.

PRICE

value: 13
Price

The metadata identifies the value and currency.