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 模型仅会为每个类别返回概率（置信度）分数，并会为部分类别返回严重程度分数。