Method: documents.moderateText

審核有害內容和敏感類別的文件。

HTTP 要求

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

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

要求主體

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

JSON 表示法 
{
  "document": {
    object (Document)
  },
  "modelVersion": enum (ModelVersion)
}
欄位
document

object (Document)

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

enum (ModelVersion)

(非必要) 要用於 documents.moderateText 的模型版本。

回應主體

文件審核回應訊息。

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

JSON 表示法 
{
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageCode": string,
  "languageSupported": boolean
}
欄位
moderationCategories[]

object (ClassificationCategory)

代表輸入文件的有害和敏感類別。
languageCode

string

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

boolean

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

授權範圍

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

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

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

ModelVersion

要用於 documents.moderateText 的模型版本。

列舉
MODEL_VERSION_UNSPECIFIED 預設模型版本。
MODEL_VERSION_1 使用 v1 模型，如果未提供，系統會預設使用這個模型。v1 模型只會傳回每個類別的機率 (可信度) 分數。
MODEL_VERSION_2 使用 v2 模型。v2 模型只會傳回每個類別的機率 (可信度) 分數，並傳回部分類別的嚴重性分數。