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)

這項方便方法可在單一呼叫中提供所有功能。

授權範圍

需要下列其中一種 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 的請求訊息，可在單一呼叫中執行多種分析類型。

欄位
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

分類器對類別的可信度。這個數字代表分類器對此類別代表指定文字的確定程度。
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 稽核記錄不受影響，因為這項功能是根據使用者資料產生。
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

代表呼叫端用來處理輸出的文字編碼。建議提供 EncodingType，因為 API 會為各種輸出內容提供起始偏移量，例如符記和提及，而原生使用不同文字編碼的語言可能會以不同方式存取偏移量。

列舉
NONE 如果未指定 EncodingType，系統會在 -1 中設定編碼相關資訊 (例如 begin_offset)。
UTF8 編碼依附資訊 (例如 begin_offset) 會根據輸入內容的 UTF-8 編碼計算。C++ 和 Go 就是使用這種編碼的原生語言。
UTF16 系統會根據輸入內容的 UTF-16 編碼，計算出依賴編碼的資訊 (例如 begin_offset)。Java 和 JavaScript 就是使用這種編碼的語言。
UTF32 系統會根據輸入內容的 UTF-32 編碼，計算與編碼相關的資訊 (例如 begin_offset)。Python 就是使用這種編碼的語言之一。

實體

代表文字中已知實體的字詞，例如人物、機構或地點。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 - 以四位數字表示的年份 (如有偵測到)
  • month - 以兩位數字表示的月份 (如果偵測到)
  • day - 以兩位數字表示的日期 (如果偵測到)
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，計算原始文件中內容的起始偏移量。