Method: documents.annotateText

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

HTTP 要求

POST https://language.googleapis.com/v2/documents:annotateText

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "document": {
    object (Document)
  },
  "features": {
    object (Features)
  },
  "encodingType": enum (EncodingType)
}
欄位
document

object (Document)

這是必要旗標，輸入文件。
features

object (Features)

這是必要旗標，已啟用的功能。
encodingType

enum (EncodingType)

API 用來計算位移的編碼類型。

回應主體

文字註解回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "sentences": [
    {
      object (Sentence)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "languageCode": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageSupported": boolean
}
欄位
sentences[]

object (Sentence)

輸入文件中的句子。如果使用者啟用 AnnotateTextRequest.Features.extract_document_sentiment，系統就會填入這項資料。
entities[]

object (Entity)

輸入文件中的實體及其語意資訊。如果使用者啟用 AnnotateTextRequest.Features.extract_entities 或 AnnotateTextRequest.Features.extract_entity_sentiment，系統就會填入這個值。
documentSentiment

object (Sentiment)

文件的整體情緒。如果使用者啟用 AnnotateTextRequest.Features.extract_document_sentiment，系統就會填入這項資料。
languageCode

string

文字的語言，與要求中指定的語言相同，如果未指定，則為自動偵測的語言。詳情請參閱 [Document.language][] 欄位。
categories[]

object (ClassificationCategory)

輸入文件中識別的類別。
moderationCategories[]

object (ClassificationCategory)

輸入文件中所識別的有害和敏感類別。
languageSupported

boolean

系統是否正式支援所有要求的功能。在語言不支援的情況下，API 仍可能會傳回回應，但這只是盡力而為。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

功能

所有可用功能。將每個值設為 true 可為輸入內容啟用特定分析。

JSON 表示法 
{
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean
}
欄位
extractEntities

boolean

(非必要) 擷取實體
extractDocumentSentiment

boolean

(非必要) 擷取文件層級的情緒。
classifyText

boolean

(非必要) 將整份文件分門別類。
moderateText

boolean

(非必要) 審核文件是否含有有害和敏感內容。