Package google.cloud.language.v2

インデックス

LanguageService

感情分析やエンティティ認識などのテキスト分析オペレーションを提供します。

AnalyzeEntities

rpc AnalyzeEntities(AnalyzeEntitiesRequest) returns (AnalyzeEntitiesResponse)

名前付きエンティティ（現時点では固有名詞と普通名詞）をテキスト内で検索し、各エンティティのエンティティ タイプ、確率、言及数、その他のプロパティを提供します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
AnalyzeSentiment

rpc AnalyzeSentiment(AnalyzeSentimentRequest) returns (AnalyzeSentimentResponse)

指定されたテキストの感情を分析します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
AnnotateText

rpc AnnotateText(AnnotateTextRequest) returns (AnnotateTextResponse)

すべての機能を 1 回の呼び出しで提供できる便利なメソッドです。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
ClassifyText

rpc ClassifyText(ClassifyTextRequest) returns (ClassifyTextResponse)

ドキュメントをカテゴリに分類します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。
ModerateText

rpc ModerateText(ModerateTextRequest) returns (ModerateTextResponse)

有害なカテゴリと機密情報のカテゴリについてドキュメントを管理します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

AnalyzeEntitiesRequest

エンティティ分析のリクエスト メッセージ。

フィールド
document

Document

必須。入力ドキュメント。
encoding_type

EncodingType

オフセットの計算に API が使用するエンコード タイプ。

AnalyzeEntitiesResponse

エンティティ分析のレスポンス メッセージ。

フィールド
entities[]

Entity

入力ドキュメント内で認識されたエンティティ。
language_code

string

テキストの言語。リクエストで指定された言語と同じですが、指定されなかった場合は自動的に検出された言語になります。詳細については、[Document.language][] フィールドをご覧ください。
language_supported

bool

言語が正式にサポートされているかどうか。言語がサポートされていない場合でも、API からレスポンスが返されることがあります。ただし、これはベスト エフォート方式です。

AnalyzeSentimentRequest

感情分析のリクエスト メッセージ。

フィールド
document

Document

必須。入力ドキュメント。
encoding_type

EncodingType

文のオフセットを計算するために API で使用されるエンコード タイプ。

AnalyzeSentimentResponse

感情分析のレスポンス メッセージ。

フィールド
document_sentiment

Sentiment

入力ドキュメントの全体的な感情。
language_code

string

テキストの言語。リクエストで指定された言語と同じですが、指定されなかった場合は自動的に検出された言語になります。詳細については、[Document.language][] フィールドをご覧ください。
sentences[]

Sentence

ドキュメント内のすべての文の感情。
language_supported

bool

言語が正式にサポートされているかどうか。言語がサポートされていない場合でも、API からレスポンスが返されることがあります。ただし、これはベスト エフォート ベースです。

AnnotateTextRequest

テキスト アノテーション API のリクエスト メッセージ。この API は、1 回の呼び出しで複数の種類の分析を実行できます。

フィールド
document

Document

必須。入力ドキュメント。
features

Features

必須。有効な機能。
encoding_type

EncodingType

オフセットの計算に API が使用するエンコード タイプ。

機能

利用可能なすべての機能。分析を個別に true に設定することで、その特定の分析を入力に対して有効にします。

フィールド
extract_entities

bool

省略可。エンティティの抽出
extract_document_sentiment

bool

省略可。ドキュメント レベルで感情を抽出します。
classify_text

bool

省略可。ドキュメント全体をカテゴリに分類します。
moderate_text

bool

省略可。有害またはデリケートなカテゴリについてドキュメントを管理します。

AnnotateTextResponse

テキスト アノテーションのレスポンス メッセージ。

フィールド
sentences[]

Sentence

入力ドキュメント内の文。ユーザーが AnnotateTextRequest.Features.extract_document_sentiment を有効にした場合に入力されます。
entities[]

Entity

入力ドキュメント内のエンティティとその意味情報。ユーザーが AnnotateTextRequest.Features.extract_entities または AnnotateTextRequest.Features.extract_entity_sentiment を有効にした場合に入力されます。
document_sentiment

Sentiment

ドキュメントの全体的な感情。ユーザーが AnnotateTextRequest.Features.extract_document_sentiment を有効にした場合に入力されます。
language_code

string

テキストの言語。リクエストで指定された言語と同じですが、指定されなかった場合は自動的に検出された言語になります。詳細については、[Document.language][] フィールドをご覧ください。
categories[]

ClassificationCategory

入力ドキュメント内で識別されたカテゴリ。
moderation_categories[]

ClassificationCategory

入力ドキュメントで検出された有害またはデリケートなカテゴリ。
language_supported

bool

リクエストされたすべての機能で言語が正式にサポートされているかどうか。言語がサポートされていない場合でも、API からレスポンスが返されることがあります。ただし、これはベスト エフォート方式です。

ClassificationCategory

テキスト分類子から返されるカテゴリを表します。

フィールド
name

string

ドキュメントを表すカテゴリの名前。
confidence

float

カテゴリの正確性に対して、分類子が持つ信頼度。number は、このカテゴリが特定のテキストを表していることの確度を表します。
severity

float

省略可。カテゴリの重大度に対して、分類子が持つ信頼度。ModerateTextRequest.ModelVersion が MODEL_VERSION_2 に設定され、対応するカテゴリに重大度スコアがある場合にのみ存在します。

ClassifyTextRequest

ドキュメントの分類のリクエスト メッセージ。

フィールド
document

Document

必須。入力ドキュメント。

ClassifyTextResponse

ドキュメントの分類のレスポンス メッセージ。

フィールド
categories[]

ClassificationCategory

入力ドキュメントを表すカテゴリ。
language_code

string

テキストの言語。リクエストで指定された言語と同じですが、指定されなかった場合は自動的に検出された言語になります。詳細については、[Document.language][] フィールドをご覧ください。
language_supported

bool

言語が正式にサポートされているかどうか。言語がサポートされていない場合でも、API からレスポンスが返されることがあります。ただし、これはベスト エフォート方式です。

ドキュメント

API メソッドへの入力を表します。

フィールド
type

Type

必須。型が設定されていないか TYPE_UNSPECIFIED の場合は、INVALID_ARGUMENT エラーを返します。
language_code

string

省略可。ドキュメントの言語（指定されていない場合、言語は自動的に検出されます）。ISO および BCP-47 の両方の言語コードを使用できます。
言語サポートには、現在それぞれの API メソッドでサポートされている言語のリストが記載されています。言語（呼び出し元によって指定された言語、または自動的に検出された言語）が呼び出された API メソッドでサポートされていない場合は、INVALID_ARGUMENT エラーが返されます。
共用体フィールド source。ドキュメントのソース（コンテンツが含まれている文字列、または Google Cloud Storage URI）。source は次のいずれかになります。
content

string

入力コンテンツ（文字列形式）。Cloud Audit Logging はユーザーデータに基づいているため、除外されています。
gcs_content_uri

string

ファイルのコンテンツが保存されている Google Cloud Storage URI。この URI は、gs://bucket_name/object_name 形式にする必要があります。詳細については、https://cloud.google.com/storage/docs/reference-uris をご覧ください。注: Cloud Storage オブジェクトのバージョン管理はサポートされていません。

タイプ

ドキュメント タイプの列挙型。

列挙型
TYPE_UNSPECIFIED コンテンツのタイプは指定しない
PLAIN_TEXT 書式なしテキスト
HTML HTML

EncodingType

出力を処理するために呼び出し側が使用する文字エンコードを表します。API はトークンや言及などのさまざまな出力の開始オフセットを指定し、異なるテキスト エンコードをネイティブで使用する言語によってオフセットへのアクセス方法が異なる可能性があることから、EncodingType を指定することをおすすめします。

列挙型
NONE EncodingType が指定されていない場合、エンコードに依存する情報（begin_offset など）は -1 に設定されます。
UTF8 エンコードに依存する情報（begin_offset など）は、入力の UTF-8 エンコードに基づいて計算されます。C++ と Go は、このエンコードをネイティブに使用する言語の例です。
UTF16 エンコードに依存する情報（begin_offset など）は、入力の UTF-16 エンコードに基づいて計算されます。Java と JavaScript は、このエンコードをネイティブに使用する言語の例です。
UTF32 エンコードに依存する情報（begin_offset など）は、入力の UTF-32 エンコードに基づいて計算されます。Python は、このエンコードをネイティブに使用する言語の例です。

Entity

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

フィールド
name

string

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

Type

エンティティ タイプ。
metadata

map<string, string>

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

他のエンティティ タイプに関連付けられるメタデータについては、タイプについて示した以下の表をご覧ください。
mentions[]

EntityMention

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

Sentiment

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

タイプ

エンティティのタイプ。次の表は、異なるメタデータを格納するエンティティの関連付けられたフィールドを示しています。

列挙型
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

料金

メタデータは、value と currency を識別します。

EntityMention

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

フィールド
text

TextSpan

言及のテキスト。
type

Type

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

Sentiment

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

float

エンティティに関連付けられた確率スコア。

このスコアは、エンティティの言及がエンティティ タイプである可能性を示します。スコアの範囲は [0, 1] です。

タイプ

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

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

ModerateTextRequest

ドキュメントの管理リクエスト メッセージ。

フィールド
document

Document

必須。入力ドキュメント。
model_version

ModelVersion

省略可。ModerateText に使用するモデル バージョン。

ModelVersion

ModerateText に使用するモデル バージョン。

列挙型
MODEL_VERSION_UNSPECIFIED デフォルトのモデル バージョン。
MODEL_VERSION_1 v1 モデルを使用します。このモデルは、指定されていない場合はデフォルトで使用されます。v1 モデルは、各カテゴリの確率（信頼度）スコアのみを返します。
MODEL_VERSION_2 v2 モデルを使用します。v2 モデルは、各カテゴリの確率（信頼度）スコアのみを返します。カテゴリの一部については、重大度スコアも返します。

ModerateTextResponse

ドキュメントの管理のレスポンス メッセージ。

フィールド
moderation_categories[]

ClassificationCategory

入力ドキュメントを表す有害なカテゴリと機密性の高いカテゴリ。
language_code

string

テキストの言語。リクエストで指定された言語と同じですが、指定されなかった場合は自動的に検出された言語になります。詳細については、[Document.language][] フィールドをご覧ください。
language_supported

bool

言語が正式にサポートされているかどうか。言語がサポートされていない場合でも、API からレスポンスが返されることがあります。ただし、これはベスト エフォート方式です。

Sentence

入力ドキュメント内の文を表します。

フィールド
text

TextSpan

文のテキスト。
sentiment

Sentiment

AnalyzeSentimentRequest を呼び出した場合、または AnnotateTextRequest.Features.extract_document_sentiment が true に設定されている場合、このフィールドには文に関する感情表現が含まれます。

センチメント

テキスト全体またはテキスト内のエンティティに関連付けられている感情を表します。

フィールド
magnitude

float

[0, +inf] の範囲の非負の数値。スコアのポジティブ性またはネガティブ性に関係なく、感情の絶対強度を表します。
score

float

-1.0（ネガティブな感情）から 1.0（ポジティブな感情）の間の感情スコア。

TextSpan

入力ドキュメント内のテキスト スパンを表します。

フィールド
content

string

テキスト スパンのコンテンツ（ドキュメントのサブ文字列）。
begin_offset

int32

API は、API リクエストで指定された EncodingType に従って、元のドキュメントのコンテンツの開始オフセットを計算します。