エンティティ

テキスト内にある、人物、組織、場所などの既知のエンティティである句を表します。API は、顕著性や言及などの情報をエンティティに関連付けます。

JSON 表現

{
  "name": string,
  "type": enum(Type),
  "metadata": {
    string: string,
    ...
  },
  "salience": number,
  "mentions": [
    {
      object(EntityMention)
    }
  ],
  "sentiment": {
    object(Sentiment)
  }
}
フィールド
name

string

エンティティを表す名前。

type

enum(Type)

エンティティ タイプ。

metadata

map (key: string, value: string)

エンティティに関連付けられたメタデータ。

ほとんどのエンティティ タイプでは、利用可能な場合は Wikipedia の URL(wikipedia_url)とナレッジグラフの MID(mid)がメタデータです。他のエンティティ タイプに関連付けられるメタデータについては、タイプについて示した以下の表をご覧ください。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

salience

number

エンティティに関連付けられる顕著性スコア([0, 1.0] の範囲)。

エンティティの顕著性スコアは、ドキュメントのテキスト全体に対するエンティティの重要性または中心性を示します。スコアが 0 に近いほど顕著性が低くなり、1.0 に近いほど顕著性が高くなります。

mentions[]

object(EntityMention)

入力ドキュメント内のこのエンティティの言及。この API は現在、固有名詞の言及をサポートしています。

sentiment

object(Sentiment)

[documents.analyzeEntitySentiment][] を呼び出した場合、または AnnotateTextRequest.Features.extract_entity_sentiment が true に設定されている場合、このフィールドには、指定されたドキュメント内でのこのエンティティに関する感情表現の集計値が格納されます。

タイプ

エンティティのタイプ。ほとんどのエンティティ タイプでは、Wikipedia の URL(wikipedia_url)とナレッジグラフの MID(mid)がメタデータとして関連付けられます。次の表は、異なるメタデータを格納するエンティティの関連付けられたフィールドを示しています。

列挙型
UNKNOWN 不明
PERSON 人物
LOCATION 場所
ORGANIZATION 組織
EVENT イベント
WORK_OF_ART アート
CONSUMER_GOOD 消費者製品
OTHER その他のタイプのエンティティ
PHONE_NUMBER

電話番号

メタデータには、ローカルの慣例に従って書式設定された電話番号と、テキスト内に表示されている追加要素の一覧が示されます。

  • number - ローカルの慣例に従ってセクションに分割された実際の番号
  • national_prefix - 国コード(検出された場合)
  • area_code - リージョンまたはエリアのコード(検出された場合)
  • extension - 接続後にダイヤルされる内線番号(検出された場合)
ADDRESS

住所

メタデータは、番地と地域区分に加え、テキストに表示されている追加要素を識別します。

  • street_number - 番地
  • locality - 市区町村
  • street_name - 通り名または路線名(検出された場合)
  • postal_code - 郵便番号(検出された場合)
  • country - 国(検出された場合)<
  • broad_region - 都道府県などの行政区域(検出された場合)
  • narrow_region - 郡などの小規模な行政区域(検出された場合)
  • sublocality - アジア地域の住所で、市区町村内の地区を識別する目的で使用(検出された場合)
DATE

日付

メタデータは、日付のコンポーネントを識別します。

  • year - 4 桁の年(検出された場合)
  • month - 月を表す 2 桁の数字(検出された場合)
  • day - 日を表す 2 桁の数字(検出された場合)
NUMBER

番号

メタデータは番号そのものです。

PRICE

料金

メタデータは、valuecurrency を識別します。

EntityMention

テキスト内のエンティティに関する言及を表します。現在は、固有名詞の言及がサポートされています。

JSON 表現

{
  "text": {
    object(TextSpan)
  },
  "type": enum(Type),
  "sentiment": {
    object(Sentiment)
  }
}
フィールド
text

object(TextSpan)

言及のテキスト。

type

enum(Type)

エンティティの言及のタイプ。

sentiment

object(Sentiment)

[documents.analyzeEntitySentiment][] を呼び出した場合、または AnnotateTextRequest.Features.extract_entity_sentiment が true に設定されている場合、このフィールドには、指定されたドキュメントにおけるエンティティについてのこの言及に関する感情表現が含まれます。

タイプ

サポートされている言及のタイプ。

列挙型
TYPE_UNKNOWN 不明
PROPER 固有名詞
COMMON 普通名詞(または複合名詞)